Send feedback
Class AuthConfig.ApiKeyConfig (3.52.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.52.0 keyboard_arrow_down
public static final class AuthConfig . ApiKeyConfig extends GeneratedMessageV3 implements AuthConfig . ApiKeyConfigOrBuilder
Config for authentication with API key.
Protobuf type google.cloud.aiplatform.v1beta1.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
public static final int API_KEY_SECRET_FIELD_NUMBER
Field Value
Type Description
int
public static final int HTTP_ELEMENT_LOCATION_FIELD_NUMBER
Field Value
Type Description
int
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static AuthConfig . ApiKeyConfig getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static AuthConfig . ApiKeyConfig . Builder newBuilder ()
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 )
public static AuthConfig . ApiKeyConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static AuthConfig . ApiKeyConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static AuthConfig . ApiKeyConfig parseFrom ( ByteString data )
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 )
public static AuthConfig . ApiKeyConfig parseFrom ( ByteBuffer data )
public static AuthConfig . ApiKeyConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<AuthConfig . ApiKeyConfig > parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public String getApiKeySecret ()
Required. The name of the SecretManager secret version resource storing
the API key. Format:
projects/{project}/secrets/{secrete}/versions/{version}
string api_key_secret = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
String The apiKeySecret.
public ByteString getApiKeySecretBytes ()
Required. The name of the SecretManager secret version resource storing
the API key. Format:
projects/{project}/secrets/{secrete}/versions/{version}
string api_key_secret = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
ByteString The bytes for apiKeySecret.
public AuthConfig . ApiKeyConfig getDefaultInstanceForType ()
public HttpElementLocation getHttpElementLocation ()
Required. The location of the API key.
.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
public int getHttpElementLocationValue ()
Required. The location of the API key.
.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
int The enum numeric value on the wire for httpElementLocation.
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.
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.
public Parser<AuthConfig . ApiKeyConfig > getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
Overrides
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public AuthConfig . ApiKeyConfig . Builder newBuilderForType ()
protected AuthConfig . ApiKeyConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public AuthConfig . ApiKeyConfig . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
