Class AuthConfig.ApiKeyConfig (0.28.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version latestkeyboard_arrow_down
public static final class AuthConfig . ApiKeyConfig extends GeneratedMessageV3 implements AuthConfig . ApiKeyConfigOrBuilder
Config for authentication with API key.
Protobuf type google.cloud.apihub.v1.AuthConfig.ApiKeyConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static AuthConfig . ApiKeyConfig . Builder newBuilder ()
newBuilder(AuthConfig.ApiKeyConfig prototype)
public static AuthConfig . ApiKeyConfig . Builder newBuilder ( AuthConfig . ApiKeyConfig prototype )
public static AuthConfig . ApiKeyConfig parseDelimitedFrom ( InputStream input )
public static AuthConfig . ApiKeyConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static AuthConfig . ApiKeyConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AuthConfig . ApiKeyConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static AuthConfig . ApiKeyConfig parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthConfig . ApiKeyConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static AuthConfig . ApiKeyConfig parseFrom ( CodedInputStream input )
public static AuthConfig . ApiKeyConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static AuthConfig . ApiKeyConfig parseFrom ( InputStream input )
public static AuthConfig . ApiKeyConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static AuthConfig . ApiKeyConfig parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AuthConfig . ApiKeyConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<AuthConfig . ApiKeyConfig > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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];
getDefaultInstanceForType()
public AuthConfig . ApiKeyConfig getDefaultInstanceForType ()
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.
getParserForType()
public Parser<AuthConfig . ApiKeyConfig > getParserForType ()
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public AuthConfig . ApiKeyConfig . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AuthConfig . ApiKeyConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public AuthConfig . ApiKeyConfig . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-02 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-02 UTC."],[],[]]
