Properties | List of all members
GPBApi Class Reference

#import <Api.pbobjc.h>

Inheritance diagram for GPBApi:
Inheritance graph
[legend]

Properties

BOOL hasSourceContext
 
NSMutableArray< GPBMethod * > * methodsArray
 
NSUInteger methodsArray_Count
 
NSMutableArray< GPBMixin * > * mixinsArray
 
NSUInteger mixinsArray_Count
 
NSString * name
 
NSMutableArray< GPBOption * > * optionsArray
 
NSUInteger optionsArray_Count
 
GPBSourceContextsourceContext
 
enum GPBSyntax syntax
 
NSString * version
 
- Properties inherited from GPBMessage
BOOL initialized
 
GPBUnknownFieldSetunknownFields
 

Additional Inherited Members

- Instance Methods inherited from GPBMessage
(void) - addExtension:value:
 
(void) - addExtension:value:
 
(void) - addUnknownMapEntry:value: [implementation]
 
(void) - addUnknownMapEntry:value: [implementation]
 
(void) - clear
 
(void) - clear
 
(void) - clearExtension:
 
(void) - clearExtension:
 
(nullable NSData *) - data
 
(nullable NSData *) - data
 
(NSData *) - delimitedData
 
(NSData *) - delimitedData
 
(GPBDescriptor *) - descriptor
 
(GPBDescriptor *) - descriptor
 
(NSArray *) - extensionsCurrentlySet
 
(NSArray *) - extensionsCurrentlySet
 
(id- getExistingExtension: [implementation]
 
(id- getExistingExtension: [implementation]
 
(nullable id- getExtension:
 
(nullable id- getExtension:
 
(BOOL- hasExtension:
 
(BOOL- hasExtension:
 
(nullable instancetype) - initWithCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) - initWithCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) - initWithData:error:
 
(nullable instancetype) - initWithData:error:
 
(nullable instancetype) - initWithData:extensionRegistry:error:
 
(nullable instancetype) - initWithData:extensionRegistry:error:
 
(void) - mergeDelimitedFromCodedInputStream:extensionRegistry: [implementation]
 
(void) - mergeDelimitedFromCodedInputStream:extensionRegistry: [implementation]
 
(void) - mergeFrom:
 
(void) - mergeFrom:
 
(void) - mergeFromCodedInputStream:extensionRegistry: [implementation]
 
(void) - mergeFromCodedInputStream:extensionRegistry: [implementation]
 
(void) - mergeFromData:extensionRegistry:
 
(void) - mergeFromData:extensionRegistry:
 
(size_t) - serializedSize
 
(size_t) - serializedSize
 
(void) - setExtension:index:value:
 
(void) - setExtension:index:value:
 
(void) - setExtension:value:
 
(void) - setExtension:value:
 
(void) - writeDelimitedToCodedOutputStream:
 
(void) - writeDelimitedToCodedOutputStream:
 
(void) - writeDelimitedToOutputStream:
 
(void) - writeDelimitedToOutputStream:
 
(void) - writeToCodedOutputStream:
 
(void) - writeToCodedOutputStream:
 
(void) - writeToOutputStream:
 
(void) - writeToOutputStream:
 
- Class Methods inherited from GPBMessage
(GPBDescriptor *) + descriptor
 
(GPBDescriptor *) + descriptor
 
(instancetype) + message
 
(instancetype) + message
 
(nullable instancetype) + parseDelimitedFromCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) + parseDelimitedFromCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) + parseFromCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) + parseFromCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) + parseFromData:error:
 
(nullable instancetype) + parseFromData:error:
 
(nullable instancetype) + parseFromData:extensionRegistry:error:
 
(nullable instancetype) + parseFromData:extensionRegistry:error:
 
- Protected Attributes inherited from GPBMessage
package GPBMessage_StoragePtr messageStorage_
 

Detailed Description

Api is a light-weight descriptor for an API Interface.

Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

Definition at line 80 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

Property Documentation

◆ hasSourceContext

- (BOOL) hasSourceContext
readwritenonatomicassign

Test to see if sourceContext has been set.

Definition at line 127 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

◆ methodsArray

- (NSMutableArray< GPBMethod * > *) methodsArray
readwritenonatomicstrong

The methods of this interface, in unspecified order.

Definition at line 89 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

◆ methodsArray_Count

- (NSUInteger) methodsArray_Count
readnonatomicassign

The number of items in methodsArray without causing the array to be created.

Definition at line 91 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

◆ mixinsArray

- (NSMutableArray< GPBMixin * > *) mixinsArray
readwritenonatomicstrong

Included interfaces. See [Mixin][].

Definition at line 130 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

◆ mixinsArray_Count

- (NSUInteger) mixinsArray_Count
readnonatomicassign

The number of items in mixinsArray without causing the array to be created.

Definition at line 132 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

◆ name

- (NSString *) name
readwritenonatomiccopy

The fully qualified name of this interface, including package name followed by the interface's simple name.

Definition at line 86 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

◆ optionsArray

- (NSMutableArray< GPBOption * > *) optionsArray
readwritenonatomicstrong

Any metadata attached to the interface.

Definition at line 94 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

◆ optionsArray_Count

- (NSUInteger) optionsArray_Count
readnonatomicassign

The number of items in optionsArray without causing the array to be created.

Definition at line 96 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

◆ sourceContext

- (GPBSourceContext *) sourceContext
readwritenonatomicstrong

Source context for the protocol buffer service represented by this message.

Definition at line 125 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

◆ syntax

- (enum GPBSyntax) syntax
readwritenonatomicassign

The source syntax of the service.

Definition at line 135 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.

◆ version

- (NSString *) version
readwritenonatomiccopy

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here.

The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan.

The major version is also reflected in the package name of the interface, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

Definition at line 119 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h.


The documentation for this class was generated from the following files:


grpc
Author(s):
autogenerated on Fri May 16 2025 03:01:44