Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class ApiAuthentication (0.1.0)

public final class ApiAuthentication extends GeneratedMessage implements ApiAuthenticationOrBuilder

Authentication information required for API calls.

Protobuf type google.cloud.ces.v1.ApiAuthentication

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ApiAuthentication

Implements

ApiAuthenticationOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

API_KEY_CONFIG_FIELD_NUMBER

public static final int API_KEY_CONFIG_FIELD_NUMBER

Field Value
Type	Description
`int`

BEARER_TOKEN_CONFIG_FIELD_NUMBER

public static final int BEARER_TOKEN_CONFIG_FIELD_NUMBER

Field Value
Type	Description
`int`

OAUTH_CONFIG_FIELD_NUMBER

public static final int OAUTH_CONFIG_FIELD_NUMBER

Field Value
Type	Description
`int`

SERVICE_ACCOUNT_AUTH_CONFIG_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_AUTH_CONFIG_FIELD_NUMBER

Field Value
Type	Description
`int`

SERVICE_AGENT_ID_TOKEN_AUTH_CONFIG_FIELD_NUMBER

public static final int SERVICE_AGENT_ID_TOKEN_AUTH_CONFIG_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static ApiAuthentication getDefaultInstance()

Returns
Type	Description
`ApiAuthentication`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static ApiAuthentication.Builder newBuilder()

Returns
Type	Description
`ApiAuthentication.Builder`

newBuilder(ApiAuthentication prototype)

public static ApiAuthentication.Builder newBuilder(ApiAuthentication prototype)

Parameter
Name	Description
`prototype`	`ApiAuthentication`

Returns
Type	Description
`ApiAuthentication.Builder`

parseDelimitedFrom(InputStream input)

public static ApiAuthentication parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiAuthentication parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static ApiAuthentication parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ApiAuthentication parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static ApiAuthentication parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ApiAuthentication parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static ApiAuthentication parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiAuthentication parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static ApiAuthentication parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ApiAuthentication parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static ApiAuthentication parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ApiAuthentication parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ApiAuthentication`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<ApiAuthentication> parser()

Returns
Type	Description
`Parser<ApiAuthentication>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getApiKeyConfig()

public ApiKeyConfig getApiKeyConfig()

Optional. Config for API key auth.

.google.cloud.ces.v1.ApiKeyConfig api_key_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ApiKeyConfig`	The apiKeyConfig.

getApiKeyConfigOrBuilder()

public ApiKeyConfigOrBuilder getApiKeyConfigOrBuilder()

Optional. Config for API key auth.

.google.cloud.ces.v1.ApiKeyConfig api_key_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ApiKeyConfigOrBuilder`

getAuthConfigCase()

public ApiAuthentication.AuthConfigCase getAuthConfigCase()

Returns
Type	Description
`ApiAuthentication.AuthConfigCase`

getBearerTokenConfig()

public BearerTokenConfig getBearerTokenConfig()

Optional. Config for bearer token auth.

.google.cloud.ces.v1.BearerTokenConfig bearer_token_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`BearerTokenConfig`	The bearerTokenConfig.

getBearerTokenConfigOrBuilder()

public BearerTokenConfigOrBuilder getBearerTokenConfigOrBuilder()

Optional. Config for bearer token auth.

.google.cloud.ces.v1.BearerTokenConfig bearer_token_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`BearerTokenConfigOrBuilder`

getDefaultInstanceForType()

public ApiAuthentication getDefaultInstanceForType()

Returns
Type	Description
`ApiAuthentication`

getOauthConfig()

public OAuthConfig getOauthConfig()

Optional. Config for OAuth.

.google.cloud.ces.v1.OAuthConfig oauth_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`OAuthConfig`	The oauthConfig.

getOauthConfigOrBuilder()

public OAuthConfigOrBuilder getOauthConfigOrBuilder()

Optional. Config for OAuth.

.google.cloud.ces.v1.OAuthConfig oauth_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`OAuthConfigOrBuilder`

getParserForType()

public Parser<ApiAuthentication> getParserForType()

Returns
Type	Description
`Parser<ApiAuthentication>`

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

getServiceAccountAuthConfig()

public ServiceAccountAuthConfig getServiceAccountAuthConfig()

Optional. Config for service account authentication.

.google.cloud.ces.v1.ServiceAccountAuthConfig service_account_auth_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ServiceAccountAuthConfig`	The serviceAccountAuthConfig.

getServiceAccountAuthConfigOrBuilder()

public ServiceAccountAuthConfigOrBuilder getServiceAccountAuthConfigOrBuilder()

Optional. Config for service account authentication.

.google.cloud.ces.v1.ServiceAccountAuthConfig service_account_auth_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ServiceAccountAuthConfigOrBuilder`

getServiceAgentIdTokenAuthConfig()

public ServiceAgentIdTokenAuthConfig getServiceAgentIdTokenAuthConfig()

Optional. Config for ID token auth generated from CES service agent.

.google.cloud.ces.v1.ServiceAgentIdTokenAuthConfig service_agent_id_token_auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ServiceAgentIdTokenAuthConfig`	The serviceAgentIdTokenAuthConfig.

getServiceAgentIdTokenAuthConfigOrBuilder()

public ServiceAgentIdTokenAuthConfigOrBuilder getServiceAgentIdTokenAuthConfigOrBuilder()

Optional. Config for ID token auth generated from CES service agent.

.google.cloud.ces.v1.ServiceAgentIdTokenAuthConfig service_agent_id_token_auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ServiceAgentIdTokenAuthConfigOrBuilder`

hasApiKeyConfig()

public boolean hasApiKeyConfig()

Optional. Config for API key auth.

.google.cloud.ces.v1.ApiKeyConfig api_key_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the apiKeyConfig field is set.

hasBearerTokenConfig()

public boolean hasBearerTokenConfig()

Optional. Config for bearer token auth.

.google.cloud.ces.v1.BearerTokenConfig bearer_token_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the bearerTokenConfig field is set.

hasOauthConfig()

public boolean hasOauthConfig()

Optional. Config for OAuth.

.google.cloud.ces.v1.OAuthConfig oauth_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the oauthConfig field is set.

hasServiceAccountAuthConfig()

public boolean hasServiceAccountAuthConfig()

Optional. Config for service account authentication.

.google.cloud.ces.v1.ServiceAccountAuthConfig service_account_auth_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the serviceAccountAuthConfig field is set.

hasServiceAgentIdTokenAuthConfig()

public boolean hasServiceAgentIdTokenAuthConfig()

Optional. Config for ID token auth generated from CES service agent.

.google.cloud.ces.v1.ServiceAgentIdTokenAuthConfig service_agent_id_token_auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the serviceAgentIdTokenAuthConfig field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public ApiAuthentication.Builder newBuilderForType()

Returns
Type	Description
`ApiAuthentication.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ApiAuthentication.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`ApiAuthentication.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public ApiAuthentication.Builder toBuilder()

Returns
Type	Description
`ApiAuthentication.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`