Api.pbobjc.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. // Generated by the protocol buffer compiler. DO NOT EDIT!
  2. // source: google/protobuf/api.proto
  3. #import "GPBProtocolBuffers.h"
  4. #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30000
  5. #error This file was generated by a different version of protoc-gen-objc which is incompatible with your Protocol Buffer sources.
  6. #endif
  7. // @@protoc_insertion_point(imports)
  8. CF_EXTERN_C_BEGIN
  9. @class GPBSourceContext;
  10. #pragma mark - GPBApiRoot
  11. @interface GPBApiRoot : GPBRootObject
  12. // The base class provides:
  13. // + (GPBExtensionRegistry *)extensionRegistry;
  14. // which is an GPBExtensionRegistry that includes all the extensions defined by
  15. // this file and all files that it depends on.
  16. @end
  17. #pragma mark - GPBApi
  18. typedef GPB_ENUM(GPBApi_FieldNumber) {
  19. GPBApi_FieldNumber_Name = 1,
  20. GPBApi_FieldNumber_MethodsArray = 2,
  21. GPBApi_FieldNumber_OptionsArray = 3,
  22. GPBApi_FieldNumber_Version = 4,
  23. GPBApi_FieldNumber_SourceContext = 5,
  24. };
  25. // Api is a light-weight descriptor for a protocol buffer service.
  26. @interface GPBApi : GPBMessage
  27. // The fully qualified name of this api, including package name
  28. // followed by the api's simple name.
  29. @property(nonatomic, readwrite, copy) NSString *name;
  30. // The methods of this api, in unspecified order.
  31. // |methodsArray| contains |GPBMethod|
  32. @property(nonatomic, readwrite, strong) NSMutableArray *methodsArray;
  33. // Any metadata attached to the API.
  34. // |optionsArray| contains |GPBOption|
  35. @property(nonatomic, readwrite, strong) NSMutableArray *optionsArray;
  36. // A version string for this api. If specified, must have the form
  37. // `major-version.minor-version`, as in `1.10`. If the minor version
  38. // is omitted, it defaults to zero. If the entire version field is
  39. // empty, the major version is derived from the package name, as
  40. // outlined below. If the field is not empty, the version in the
  41. // package name will be verified to be consistent with what is
  42. // provided here.
  43. //
  44. // The versioning schema uses [semantic
  45. // versioning](http://semver.org) where the major version number
  46. // indicates a breaking change and the minor version an additive,
  47. // non-breaking change. Both version numbers are signals to users
  48. // what to expect from different versions, and should be carefully
  49. // chosen based on the product plan.
  50. //
  51. // The major version is also reflected in the package name of the
  52. // API, which must end in `v<major-version>`, as in
  53. // `google.feature.v1`. For major versions 0 and 1, the suffix can
  54. // be omitted. Zero major versions must only be used for
  55. // experimental, none-GA apis.
  56. //
  57. // See also: [design doc](http://go/api-versioning).
  58. @property(nonatomic, readwrite, copy) NSString *version;
  59. // Source context for the protocol buffer service represented by this
  60. // message.
  61. @property(nonatomic, readwrite) BOOL hasSourceContext;
  62. @property(nonatomic, readwrite, strong) GPBSourceContext *sourceContext;
  63. @end
  64. #pragma mark - GPBMethod
  65. typedef GPB_ENUM(GPBMethod_FieldNumber) {
  66. GPBMethod_FieldNumber_Name = 1,
  67. GPBMethod_FieldNumber_RequestTypeURL = 2,
  68. GPBMethod_FieldNumber_RequestStreaming = 3,
  69. GPBMethod_FieldNumber_ResponseTypeURL = 4,
  70. GPBMethod_FieldNumber_ResponseStreaming = 5,
  71. GPBMethod_FieldNumber_OptionsArray = 6,
  72. };
  73. // Method represents a method of an api.
  74. @interface GPBMethod : GPBMessage
  75. // The simple name of this method.
  76. @property(nonatomic, readwrite, copy) NSString *name;
  77. // A URL of the input message type.
  78. @property(nonatomic, readwrite, copy) NSString *requestTypeURL;
  79. // If true, the request is streamed.
  80. @property(nonatomic, readwrite) BOOL requestStreaming;
  81. // The URL of the output message type.
  82. @property(nonatomic, readwrite, copy) NSString *responseTypeURL;
  83. // If true, the response is streamed.
  84. @property(nonatomic, readwrite) BOOL responseStreaming;
  85. // Any metadata attached to the method.
  86. // |optionsArray| contains |GPBOption|
  87. @property(nonatomic, readwrite, strong) NSMutableArray *optionsArray;
  88. @end
  89. CF_EXTERN_C_END
  90. // @@protoc_insertion_point(global_scope)