Class AWSV4Signature.Builder (1.45.0)

Version 1.45.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public static final class AWSV4Signature.Builder extends GeneratedMessageV3.Builder<AWSV4Signature.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AWSV4Signature.Builder

Implements

AWSV4SignatureOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AWSV4Signature.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
AWSV4Signature.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public AWSV4Signature build()

Returns
Type	Description
AWSV4Signature

buildPartial()

public AWSV4Signature buildPartial()

Returns
Type	Description
AWSV4Signature

clear()

public AWSV4Signature.Builder clear()

Returns
Type	Description
AWSV4Signature.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAccessKey()

public AWSV4Signature.Builder clearAccessKey()

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
AWSV4Signature.Builder	This builder for chaining.

clearAccessKeyId()

public AWSV4Signature.Builder clearAccessKeyId()

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

optional string access_key_id = 292975158;

Returns
Type	Description
AWSV4Signature.Builder	This builder for chaining.

clearAccessKeyVersion()

public AWSV4Signature.Builder clearAccessKeyVersion()

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
AWSV4Signature.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AWSV4Signature.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
AWSV4Signature.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public AWSV4Signature.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
AWSV4Signature.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOriginRegion()

public AWSV4Signature.Builder clearOriginRegion()

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
AWSV4Signature.Builder	This builder for chaining.

clone()

public AWSV4Signature.Builder clone()

Returns
Type	Description
AWSV4Signature.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(AWSV4Signature other)

public AWSV4Signature.Builder mergeFrom(AWSV4Signature other)

Parameter
Name	Description
other	AWSV4Signature

Returns
Type	Description
AWSV4Signature.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AWSV4Signature.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AWSV4Signature.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public AWSV4Signature.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
AWSV4Signature.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AWSV4Signature.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
AWSV4Signature.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAccessKey(String value)

public AWSV4Signature.Builder setAccessKey(String value)

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;

Parameter
Name	Description
value	String The accessKey to set.

Returns
Type	Description
AWSV4Signature.Builder	This builder for chaining.

setAccessKeyBytes(ByteString value)

public AWSV4Signature.Builder setAccessKeyBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for accessKey to set.

Returns
Type	Description
AWSV4Signature.Builder	This builder for chaining.

setAccessKeyId(String value)

public AWSV4Signature.Builder setAccessKeyId(String value)

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

optional string access_key_id = 292975158;

Parameter
Name	Description
value	String The accessKeyId to set.

Returns
Type	Description
AWSV4Signature.Builder	This builder for chaining.

setAccessKeyIdBytes(ByteString value)

public AWSV4Signature.Builder setAccessKeyIdBytes(ByteString value)

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

optional string access_key_id = 292975158;

Parameter
Name	Description
value	ByteString The bytes for accessKeyId to set.

Returns
Type	Description
AWSV4Signature.Builder	This builder for chaining.

setAccessKeyVersion(String value)

public AWSV4Signature.Builder setAccessKeyVersion(String value)

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;

Parameter
Name	Description
value	String The accessKeyVersion to set.

Returns
Type	Description
AWSV4Signature.Builder	This builder for chaining.

setAccessKeyVersionBytes(ByteString value)

public AWSV4Signature.Builder setAccessKeyVersionBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for accessKeyVersion to set.

Returns
Type	Description
AWSV4Signature.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AWSV4Signature.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
AWSV4Signature.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setOriginRegion(String value)

public AWSV4Signature.Builder setOriginRegion(String value)

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;

Parameter
Name	Description
value	String The originRegion to set.

Returns
Type	Description
AWSV4Signature.Builder	This builder for chaining.

setOriginRegionBytes(ByteString value)

public AWSV4Signature.Builder setOriginRegionBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for originRegion to set.

Returns
Type	Description
AWSV4Signature.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AWSV4Signature.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
AWSV4Signature.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final AWSV4Signature.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
AWSV4Signature.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)