com.google.api

Class ClientProto

java.lang.Object

com.google.api.ClientProto

public final class ClientProto
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HOST_FIELD_NUMBER
static GeneratedMessage.GeneratedExtension<DescriptorProtos.ServiceOptions,java.lang.String>	defaultHost The hostname for this service.
static int	METHOD_SIGNATURE_FIELD_NUMBER
static GeneratedMessage.GeneratedExtension<DescriptorProtos.MethodOptions,java.util.List<java.lang.String>>	methodSignature A definition of a client library method signature.
static int	OAUTH_SCOPES_FIELD_NUMBER
static GeneratedMessage.GeneratedExtension<DescriptorProtos.ServiceOptions,java.lang.String>	oauthScopes OAuth scopes needed for the client.

Method Summary

Modifier and Type	Method and Description
static Descriptors.FileDescriptor	getDescriptor()
static void	registerAllExtensions(ExtensionRegistry registry)
static void	registerAllExtensions(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 GeneratedMessage.GeneratedExtension<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 GeneratedMessage.GeneratedExtension<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 GeneratedMessage.GeneratedExtension<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 { ... }

Method Detail

registerAllExtensions

public static void registerAllExtensions(ExtensionRegistryLite registry)

registerAllExtensions

public static void registerAllExtensions(ExtensionRegistry registry)

getDescriptor

public static Descriptors.FileDescriptor getDescriptor()