Class ClientProto


  • public final class ClientProto
    extends java.lang.Object
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int API_VERSION_FIELD_NUMBER  
      static com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,​java.lang.String> apiVersion
      The API version of this service, which should be sent by version-aware clients to the service.
      static int DEFAULT_HOST_FIELD_NUMBER  
      static com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,​java.lang.String> defaultHost
      The hostname for this service.
      static int METHOD_SIGNATURE_FIELD_NUMBER  
      static com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,​java.util.List<java.lang.String>> methodSignature
      A definition of a client library method signature.
      static int OAUTH_SCOPES_FIELD_NUMBER  
      static com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,​java.lang.String> oauthScopes
      OAuth scopes needed for the client.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static com.google.protobuf.Descriptors.FileDescriptor getDescriptor()  
      static void registerAllExtensions​(com.google.protobuf.ExtensionRegistry registry)  
      static void registerAllExtensions​(com.google.protobuf.ExtensionRegistryLite registry)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • METHOD_SIGNATURE_FIELD_NUMBER

        public static final int METHOD_SIGNATURE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • methodSignature

        public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,​java.util.List<java.lang.String>> methodSignature
         A 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:
        Constant Field Values
      • defaultHost

        public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,​java.lang.String> defaultHost
         The 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:
        Constant Field Values
      • oauthScopes

        public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,​java.lang.String> oauthScopes
         OAuth 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 { ... }
      • API_VERSION_FIELD_NUMBER

        public static final int API_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • apiVersion

        public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,​java.lang.String> apiVersion
         The API version of this service, which should be sent by version-aware
         clients to the service. This allows services to abide by the schema and
         behavior of the service at the time this API version was deployed.
         The format of the API version must be treated as opaque by clients.
         Services may use a format with an apparent structure, but clients must
         not rely on this to determine components within an API version, or attempt
         to construct other valid API versions. Note that this is for upcoming
         functionality and may not be implemented for all services.
        
         Example:
        
           service Foo {
             option (google.api.api_version) = "v1_20230821_preview";
           }
         
        extend .google.protobuf.ServiceOptions { ... }
    • Method Detail

      • 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()