public static final class AuthConfig.ApiKeyConfig.Builder extends GeneratedMessage.Builder<AuthConfig.ApiKeyConfig.Builder> implements AuthConfig.ApiKeyConfigOrBuilderConfig for authentication with API key.
Protobuf type google.cloud.apihub.v1.AuthConfig.ApiKeyConfig
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AuthConfig.ApiKeyConfig.BuilderImplements
AuthConfig.ApiKeyConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
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];
| Returns | |
|---|---|
| Type | Description |
AuthConfig.ApiKeyConfig.Builder |
|
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];
| 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. |
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];
| Returns | |
|---|---|
| Type | Description |
Secret.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.ApiKeyConfig.Builder |
|
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 |
|
| 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 |
|
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 |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.ApiKeyConfig.Builder |
|
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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Secret.Builder |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.ApiKeyConfig.Builder |
|
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];
| Parameter | |
|---|---|
| Name | Description |
value |
AuthConfig.ApiKeyConfig.HttpElementLocationThe 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. 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 |
intThe 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 |
StringThe 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 |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.ApiKeyConfig.Builder |
This builder for chaining. |