Class AWSV4Signature (1.56.0)

public final class AWSV4Signature extends GeneratedMessageV3 implements AWSV4SignatureOrBuilder

Messages

Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to 's3'.

Protobuf type google.cloud.compute.v1.AWSV4Signature

Static Fields

ACCESS_KEY_FIELD_NUMBER

public static final int ACCESS_KEY_FIELD_NUMBER
Field Value
Type Description
int

ACCESS_KEY_ID_FIELD_NUMBER

public static final int ACCESS_KEY_ID_FIELD_NUMBER
Field Value
Type Description
int

ACCESS_KEY_VERSION_FIELD_NUMBER

public static final int ACCESS_KEY_VERSION_FIELD_NUMBER
Field Value
Type Description
int

ORIGIN_REGION_FIELD_NUMBER

public static final int ORIGIN_REGION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AWSV4Signature getDefaultInstance()
Returns
Type Description
AWSV4Signature

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AWSV4Signature.Builder newBuilder()
Returns
Type Description
AWSV4Signature.Builder

newBuilder(AWSV4Signature prototype)

public static AWSV4Signature.Builder newBuilder(AWSV4Signature prototype)
Parameter
Name Description
prototype AWSV4Signature
Returns
Type Description
AWSV4Signature.Builder

parseDelimitedFrom(InputStream input)

public static AWSV4Signature parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AWSV4Signature parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AWSV4Signature parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AWSV4Signature parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AWSV4Signature parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AWSV4Signature parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AWSV4Signature parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AWSV4Signature parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AWSV4Signature parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AWSV4Signature parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AWSV4Signature parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AWSV4Signature parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AWSV4Signature
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AWSV4Signature> parser()
Returns
Type Description
Parser<AWSV4Signature>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAccessKey()

public String getAccessKey()

The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly

optional string access_key = 468922628;

Returns
Type Description
String

The accessKey.

getAccessKeyBytes()

public ByteString getAccessKeyBytes()

The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly

optional string access_key = 468922628;

Returns
Type Description
ByteString

The bytes for accessKey.

getAccessKeyId()

public String getAccessKeyId()

The identifier of an access key used for s3 bucket authentication.

optional string access_key_id = 292975158;

Returns
Type Description
String

The accessKeyId.

getAccessKeyIdBytes()

public ByteString getAccessKeyIdBytes()

The identifier of an access key used for s3 bucket authentication.

optional string access_key_id = 292975158;

Returns
Type Description
ByteString

The bytes for accessKeyId.

getAccessKeyVersion()

public String getAccessKeyVersion()

The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.

optional string access_key_version = 80261277;

Returns
Type Description
String

The accessKeyVersion.

getAccessKeyVersionBytes()

public ByteString getAccessKeyVersionBytes()

The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.

optional string access_key_version = 80261277;

Returns
Type Description
ByteString

The bytes for accessKeyVersion.

getDefaultInstanceForType()

public AWSV4Signature getDefaultInstanceForType()
Returns
Type Description
AWSV4Signature

getOriginRegion()

public String getOriginRegion()

The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.

optional string origin_region = 265305645;

Returns
Type Description
String

The originRegion.

getOriginRegionBytes()

public ByteString getOriginRegionBytes()

The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.

optional string origin_region = 265305645;

Returns
Type Description
ByteString

The bytes for originRegion.

getParserForType()

public Parser<AWSV4Signature> getParserForType()
Returns
Type Description
Parser<AWSV4Signature>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAccessKey()

public boolean hasAccessKey()

The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly

optional string access_key = 468922628;

Returns
Type Description
boolean

Whether the accessKey field is set.

hasAccessKeyId()

public boolean hasAccessKeyId()

The identifier of an access key used for s3 bucket authentication.

optional string access_key_id = 292975158;

Returns
Type Description
boolean

Whether the accessKeyId field is set.

hasAccessKeyVersion()

public boolean hasAccessKeyVersion()

The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.

optional string access_key_version = 80261277;

Returns
Type Description
boolean

Whether the accessKeyVersion field is set.

hasOriginRegion()

public boolean hasOriginRegion()

The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.

optional string origin_region = 265305645;

Returns
Type Description
boolean

Whether the originRegion field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AWSV4Signature.Builder newBuilderForType()
Returns
Type Description
AWSV4Signature.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AWSV4Signature.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AWSV4Signature.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AWSV4Signature.Builder toBuilder()
Returns
Type Description
AWSV4Signature.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException