public final class ApiKeyConfig extends GeneratedMessage implements ApiKeyConfigOrBuilder
Configurations for authentication with API key.
Protobuf type google.cloud.ces.v1.ApiKeyConfig
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
API_KEY_SECRET_VERSION_FIELD_NUMBER
public static final int API_KEY_SECRET_VERSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
KEY_NAME_FIELD_NUMBER
public static final int KEY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUEST_LOCATION_FIELD_NUMBER
public static final int REQUEST_LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ApiKeyConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ApiKeyConfig.Builder newBuilder()
newBuilder(ApiKeyConfig prototype)
public static ApiKeyConfig.Builder newBuilder(ApiKeyConfig prototype)
public static ApiKeyConfig parseDelimitedFrom(InputStream input)
public static ApiKeyConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ApiKeyConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ApiKeyConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ApiKeyConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ApiKeyConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ApiKeyConfig parseFrom(CodedInputStream input)
public static ApiKeyConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ApiKeyConfig parseFrom(InputStream input)
public static ApiKeyConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ApiKeyConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ApiKeyConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ApiKeyConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getApiKeySecretVersion()
public String getApiKeySecretVersion()
Required. The name of the SecretManager secret version resource storing the
API key. Format: projects/{project}/secrets/{secret}/versions/{version}
Note: You should grant roles/secretmanager.secretAccessor role to the CES
service agent
service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
string api_key_secret_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The apiKeySecretVersion.
|
getApiKeySecretVersionBytes()
public ByteString getApiKeySecretVersionBytes()
Required. The name of the SecretManager secret version resource storing the
API key. Format: projects/{project}/secrets/{secret}/versions/{version}
Note: You should grant roles/secretmanager.secretAccessor role to the CES
service agent
service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
string api_key_secret_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for apiKeySecretVersion.
|
getDefaultInstanceForType()
public ApiKeyConfig getDefaultInstanceForType()
getKeyName()
public String getKeyName()
Required. The parameter name or the header name of the API key.
E.g., If the API request is "https://example.com/act?X-Api-Key=<API
KEY>", "X-Api-Key" would be the parameter name.
string key_name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The keyName.
|
getKeyNameBytes()
public ByteString getKeyNameBytes()
Required. The parameter name or the header name of the API key.
E.g., If the API request is "https://example.com/act?X-Api-Key=<API
KEY>", "X-Api-Key" would be the parameter name.
string key_name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for keyName.
|
getParserForType()
public Parser<ApiKeyConfig> getParserForType()
Overrides
getRequestLocation()
public ApiKeyConfig.RequestLocation getRequestLocation()
Required. Key location in the request.
.google.cloud.ces.v1.ApiKeyConfig.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];
getRequestLocationValue()
public int getRequestLocationValue()
Required. Key location in the request.
.google.cloud.ces.v1.ApiKeyConfig.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for requestLocation.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ApiKeyConfig.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected ApiKeyConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public ApiKeyConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
