Class AuthConfig.ApiKeyConfig (0.36.0) 

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

Config for authentication with API key.

Protobuf type google.cloud.apihub.v1.AuthConfig.ApiKeyConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > AuthConfig.ApiKeyConfig

Static Fields

API_KEY_FIELD_NUMBER

public static final int API_KEY_FIELD_NUMBER
Field Value
Type Description
int

HTTP_ELEMENT_LOCATION_FIELD_NUMBER

public static final int HTTP_ELEMENT_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AuthConfig.ApiKeyConfig getDefaultInstance()
Returns
Type Description
AuthConfig.ApiKeyConfig

getDescriptor()

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

newBuilder()

public static AuthConfig.ApiKeyConfig.Builder newBuilder()
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

newBuilder(AuthConfig.ApiKeyConfig prototype)

public static AuthConfig.ApiKeyConfig.Builder newBuilder(AuthConfig.ApiKeyConfig prototype)
Parameter
Name Description
prototype AuthConfig.ApiKeyConfig
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

parseDelimitedFrom(InputStream input)

public static AuthConfig.ApiKeyConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AuthConfig.ApiKeyConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AuthConfig.ApiKeyConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AuthConfig.ApiKeyConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AuthConfig.ApiKeyConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AuthConfig.ApiKeyConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AuthConfig.ApiKeyConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthConfig.ApiKeyConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getApiKey()

public Secret getApiKey()

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}. The secretmanager.versions.access permission should be granted to the service account accessing the secret.

.google.cloud.apihub.v1.Secret api_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Secret

The apiKey.

getApiKeyOrBuilder()

public SecretOrBuilder getApiKeyOrBuilder()

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}. The secretmanager.versions.access permission should be granted to the service account accessing the secret.

.google.cloud.apihub.v1.Secret api_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SecretOrBuilder

getDefaultInstanceForType()

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

getHttpElementLocation()

public AuthConfig.ApiKeyConfig.HttpElementLocation getHttpElementLocation()

Required. The location of the API key. The default value is QUERY.

.google.cloud.apihub.v1.AuthConfig.ApiKeyConfig.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AuthConfig.ApiKeyConfig.HttpElementLocation

The httpElementLocation.

getHttpElementLocationValue()

public int getHttpElementLocationValue()

Required. The location of the API key. The default value is QUERY.

.google.cloud.apihub.v1.AuthConfig.ApiKeyConfig.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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasApiKey()

public boolean hasApiKey()

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}. The secretmanager.versions.access permission should be granted to the service account accessing the secret.

.google.cloud.apihub.v1.Secret api_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the apiKey field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AuthConfig.ApiKeyConfig.Builder newBuilderForType()
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AuthConfig.ApiKeyConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder
Overrides

toBuilder()

public AuthConfig.ApiKeyConfig.Builder toBuilder()
Returns
Type Description
AuthConfig.ApiKeyConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException