Class AuthConfig.ApiKeyConfig.Builder (3.42.0)

public static final class AuthConfig.ApiKeyConfig.Builder extends GeneratedMessageV3.Builder<AuthConfig.ApiKeyConfig.Builder> implements AuthConfig.ApiKeyConfigOrBuilder

Config for authentication with API key.

Protobuf type google.cloud.aiplatform.v1beta1.AuthConfig.ApiKeyConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AuthConfig.ApiKeyConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides

build()

public AuthConfig.ApiKeyConfig build()
Returns
Type Description
AuthConfig.ApiKeyConfig

buildPartial()

public AuthConfig.ApiKeyConfig buildPartial()
Returns
Type Description
AuthConfig.ApiKeyConfig

clear()

public AuthConfig.ApiKeyConfig.Builder clear()
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides

clearApiKeySecret()

public AuthConfig.ApiKeyConfig.Builder clearApiKeySecret()

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}

string api_key_secret = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AuthConfig.ApiKeyConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides

clearHttpElementLocation()

public AuthConfig.ApiKeyConfig.Builder clearHttpElementLocation()

Required. The location of the API key.

.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

This builder for chaining.

clearName()

public AuthConfig.ApiKeyConfig.Builder clearName()

Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=<API KEY>", "api_key" would be the parameter name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AuthConfig.ApiKeyConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides

clone()

public AuthConfig.ApiKeyConfig.Builder clone()
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides

getApiKeySecret()

public String getApiKeySecret()

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}

string api_key_secret = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The apiKeySecret.

getApiKeySecretBytes()

public ByteString getApiKeySecretBytes()

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}

string api_key_secret = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for apiKeySecret.

getDefaultInstanceForType()

public AuthConfig.ApiKeyConfig getDefaultInstanceForType()
Returns
Type Description
AuthConfig.ApiKeyConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHttpElementLocation()

public HttpElementLocation getHttpElementLocation()

Required. The location of the API key.

.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
HttpElementLocation

The httpElementLocation.

getHttpElementLocationValue()

public int getHttpElementLocationValue()

Required. The location of the API key.

.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for httpElementLocation.

getName()

public String getName()

Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=<API KEY>", "api_key" would be the parameter name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=<API KEY>", "api_key" would be the parameter name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AuthConfig.ApiKeyConfig other)

public AuthConfig.ApiKeyConfig.Builder mergeFrom(AuthConfig.ApiKeyConfig other)
Parameter
Name Description
other AuthConfig.ApiKeyConfig
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AuthConfig.ApiKeyConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AuthConfig.ApiKeyConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AuthConfig.ApiKeyConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides

setApiKeySecret(String value)

public AuthConfig.ApiKeyConfig.Builder setApiKeySecret(String value)

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}

string api_key_secret = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The apiKeySecret to set.

Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

This builder for chaining.

setApiKeySecretBytes(ByteString value)

public AuthConfig.ApiKeyConfig.Builder setApiKeySecretBytes(ByteString value)

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}

string api_key_secret = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for apiKeySecret to set.

Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AuthConfig.ApiKeyConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides

setHttpElementLocation(HttpElementLocation value)

public AuthConfig.ApiKeyConfig.Builder setHttpElementLocation(HttpElementLocation value)

Required. The location of the API key.

.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value HttpElementLocation

The httpElementLocation to set.

Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

This builder for chaining.

setHttpElementLocationValue(int value)

public AuthConfig.ApiKeyConfig.Builder setHttpElementLocationValue(int value)

Required. The location of the API key.

.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for httpElementLocation to set.

Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

This builder for chaining.

setName(String value)

public AuthConfig.ApiKeyConfig.Builder setName(String value)

Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=<API KEY>", "api_key" would be the parameter name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AuthConfig.ApiKeyConfig.Builder setNameBytes(ByteString value)

Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=<API KEY>", "api_key" would be the parameter name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AuthConfig.ApiKeyConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AuthConfig.ApiKeyConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides