Package com.google.cloud.apihub.v1
Class AuthConfig.ApiKeyConfig.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AuthConfig.ApiKeyConfig.Builder>
com.google.cloud.apihub.v1.AuthConfig.ApiKeyConfig.Builder
- All Implemented Interfaces:
AuthConfig.ApiKeyConfigOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- AuthConfig.ApiKeyConfig
public static final class AuthConfig.ApiKeyConfig.Builder
extends com.google.protobuf.GeneratedMessage.Builder<AuthConfig.ApiKeyConfig.Builder>
implements AuthConfig.ApiKeyConfigOrBuilder
Config for authentication with API key.Protobuf type
google.cloud.apihub.v1.AuthConfig.ApiKeyConfig-
Method Summary
Modifier and TypeMethodDescriptionbuild()clear()Required.Required.Required.Required.Required.Required.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorRequired.intRequired.getName()Required.com.google.protobuf.ByteStringRequired.booleanRequired.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeApiKey(Secret value) Required.mergeFrom(AuthConfig.ApiKeyConfig other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) Required.setApiKey(Secret.Builder builderForValue) Required.Required.setHttpElementLocationValue(int value) Required.Required.setNameBytes(com.google.protobuf.ByteString value) Required.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<AuthConfig.ApiKeyConfig.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<AuthConfig.ApiKeyConfig.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<AuthConfig.ApiKeyConfig.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<AuthConfig.ApiKeyConfig.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<AuthConfig.ApiKeyConfig.Builder>
-
mergeFrom
public AuthConfig.ApiKeyConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<AuthConfig.ApiKeyConfig.Builder>- Throws:
IOException
-
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];- Specified by:
getNamein interfaceAuthConfig.ApiKeyConfigOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.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];- Specified by:
getNameBytesin interfaceAuthConfig.ApiKeyConfigOrBuilder- Returns:
- The bytes for name.
-
setName
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];- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
setNameBytes
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];- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
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];- Specified by:
hasApiKeyin interfaceAuthConfig.ApiKeyConfigOrBuilder- Returns:
- Whether the apiKey field is set.
-
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];- Specified by:
getApiKeyin interfaceAuthConfig.ApiKeyConfigOrBuilder- Returns:
- The apiKey.
-
setApiKey
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]; -
setApiKey
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]; -
mergeApiKey
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]; -
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]; -
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
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];- Specified by:
getApiKeyOrBuilderin interfaceAuthConfig.ApiKeyConfigOrBuilder
-
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];- Specified by:
getHttpElementLocationValuein interfaceAuthConfig.ApiKeyConfigOrBuilder- Returns:
- The enum numeric value on the wire for httpElementLocation.
-
setHttpElementLocationValue
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];- Parameters:
value- The enum numeric value on the wire for httpElementLocation to set.- Returns:
- This builder for chaining.
-
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];- Specified by:
getHttpElementLocationin interfaceAuthConfig.ApiKeyConfigOrBuilder- Returns:
- The httpElementLocation.
-
setHttpElementLocation
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];- Parameters:
value- The httpElementLocation to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-