Package com.google.api
Class ClientProto
java.lang.Object
com.google.api.ClientProto
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,
String> The hostname for this service.static final int
static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,
List<String>> A definition of a client library method signature.static final int
static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,
String> OAuth scopes needed for the client. -
Method Summary
Modifier and TypeMethodDescriptionstatic com.google.protobuf.Descriptors.FileDescriptor
static void
registerAllExtensions
(com.google.protobuf.ExtensionRegistry registry) static void
registerAllExtensions
(com.google.protobuf.ExtensionRegistryLite registry)
-
Field Details
-
METHOD_SIGNATURE_FIELD_NUMBER
public static final int METHOD_SIGNATURE_FIELD_NUMBER- See Also:
-
methodSignature
public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,List<String>> methodSignatureA definition of a client library method signature. In client libraries, each proto RPC corresponds to one or more methods which the end user is able to call, and calls the underlying RPC. Normally, this method receives a single argument (a struct or instance corresponding to the RPC request object). Defining this field will add one or more overloads providing flattened or simpler method signatures in some languages. The fields on the method signature are provided as a comma-separated string. For example, the proto RPC and annotation: rpc CreateSubscription(CreateSubscriptionRequest) returns (Subscription) { option (google.api.method_signature) = "name,topic"; } Would add the following Java overload (in addition to the method accepting the request object): public final Subscription createSubscription(String name, String topic) The following backwards-compatibility guidelines apply: * Adding this annotation to an unannotated method is backwards compatible. * Adding this annotation to a method which already has existing method signature annotations is backwards compatible if and only if the new method signature annotation is last in the sequence. * Modifying or removing an existing method signature annotation is a breaking change. * Re-ordering existing method signature annotations is a breaking change.
extend .google.protobuf.MethodOptions { ... }
-
DEFAULT_HOST_FIELD_NUMBER
public static final int DEFAULT_HOST_FIELD_NUMBER- See Also:
-
defaultHost
public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,String> defaultHostThe hostname for this service. This should be specified with no prefix or protocol. Example: service Foo { option (google.api.default_host) = "foo.googleapi.com"; ... }
extend .google.protobuf.ServiceOptions { ... }
-
OAUTH_SCOPES_FIELD_NUMBER
public static final int OAUTH_SCOPES_FIELD_NUMBER- See Also:
-
oauthScopes
public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,String> oauthScopesOAuth scopes needed for the client. Example: service Foo { option (google.api.oauth_scopes) = \ "https://www.googleapis.com/auth/cloud-platform"; ... } If there is more than one scope, use a comma-separated string: Example: service Foo { option (google.api.oauth_scopes) = \ "https://www.googleapis.com/auth/cloud-platform," "https://www.googleapis.com/auth/monitoring"; ... }
extend .google.protobuf.ServiceOptions { ... }
-
-
Method Details
-
registerAllExtensions
public static void registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry) -
registerAllExtensions
public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry registry) -
getDescriptor
public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor()
-