Class AuthConfig.ApiKeyConfig (3.40.0)

public static final class AuthConfig.ApiKeyConfig extends GeneratedMessageV3 implements AuthConfig.ApiKeyConfigOrBuilder

Config for authentication with API key.

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

Static Fields

API_KEY_SECRET_FIELD_NUMBER

public static final int API_KEY_SECRET_FIELD_NUMBER
Field Value
TypeDescription
int

HTTP_ELEMENT_LOCATION_FIELD_NUMBER

public static final int HTTP_ELEMENT_LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AuthConfig.ApiKeyConfig getDefaultInstance()
Returns
TypeDescription
AuthConfig.ApiKeyConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AuthConfig.ApiKeyConfig.Builder newBuilder()
Returns
TypeDescription
AuthConfig.ApiKeyConfig.Builder

newBuilder(AuthConfig.ApiKeyConfig prototype)

public static AuthConfig.ApiKeyConfig.Builder newBuilder(AuthConfig.ApiKeyConfig prototype)
Parameter
NameDescription
prototypeAuthConfig.ApiKeyConfig
Returns
TypeDescription
AuthConfig.ApiKeyConfig.Builder

parseDelimitedFrom(InputStream input)

public static AuthConfig.ApiKeyConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AuthConfig.ApiKeyConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AuthConfig.ApiKeyConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AuthConfig.ApiKeyConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AuthConfig.ApiKeyConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AuthConfig.ApiKeyConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthConfig.ApiKeyConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AuthConfig.ApiKeyConfig> parser()
Returns
TypeDescription
Parser<ApiKeyConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
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
TypeDescription
ByteString

The bytes for apiKeySecret.

getDefaultInstanceForType()

public AuthConfig.ApiKeyConfig getDefaultInstanceForType()
Returns
TypeDescription
AuthConfig.ApiKeyConfig

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<AuthConfig.ApiKeyConfig> getParserForType()
Returns
TypeDescription
Parser<ApiKeyConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AuthConfig.ApiKeyConfig.Builder newBuilderForType()
Returns
TypeDescription
AuthConfig.ApiKeyConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AuthConfig.ApiKeyConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AuthConfig.ApiKeyConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AuthConfig.ApiKeyConfig.Builder toBuilder()
Returns
TypeDescription
AuthConfig.ApiKeyConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException