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.apihub.v1.AuthConfig.ApiKeyConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AuthConfig.ApiKeyConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public AuthConfig.ApiKeyConfig build()
buildPartial()
public AuthConfig.ApiKeyConfig buildPartial()
clear()
public AuthConfig.ApiKeyConfig.Builder clear()
Overrides
clearApiKey()
public AuthConfig.ApiKeyConfig.Builder clearApiKey()
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];
clearField(Descriptors.FieldDescriptor field)
public AuthConfig.ApiKeyConfig.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearHttpElementLocation()
public AuthConfig.ApiKeyConfig.Builder clearHttpElementLocation()
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];
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public AuthConfig.ApiKeyConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public AuthConfig.ApiKeyConfig.Builder clone()
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.
|
getApiKeyBuilder()
public Secret.Builder getApiKeyBuilder()
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];
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];
getDefaultInstanceForType()
public AuthConfig.ApiKeyConfig getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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];
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()
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.
|
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeApiKey(Secret value)
public AuthConfig.ApiKeyConfig.Builder mergeApiKey(Secret value)
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];
Parameter |
Name |
Description |
value |
Secret
|
mergeFrom(AuthConfig.ApiKeyConfig other)
public AuthConfig.ApiKeyConfig.Builder mergeFrom(AuthConfig.ApiKeyConfig other)
public AuthConfig.ApiKeyConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public AuthConfig.ApiKeyConfig.Builder mergeFrom(Message other)
Parameter |
Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AuthConfig.ApiKeyConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setApiKey(Secret value)
public AuthConfig.ApiKeyConfig.Builder setApiKey(Secret value)
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];
Parameter |
Name |
Description |
value |
Secret
|
setApiKey(Secret.Builder builderForValue)
public AuthConfig.ApiKeyConfig.Builder setApiKey(Secret.Builder builderForValue)
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];
setField(Descriptors.FieldDescriptor field, Object value)
public AuthConfig.ApiKeyConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setHttpElementLocation(AuthConfig.ApiKeyConfig.HttpElementLocation value)
public AuthConfig.ApiKeyConfig.Builder setHttpElementLocation(AuthConfig.ApiKeyConfig.HttpElementLocation value)
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];
setHttpElementLocationValue(int value)
public AuthConfig.ApiKeyConfig.Builder setHttpElementLocationValue(int value)
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];
Parameter |
Name |
Description |
value |
int
The enum numeric value on the wire for httpElementLocation to set.
|
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.
|
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.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AuthConfig.ApiKeyConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final AuthConfig.ApiKeyConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides