com.google.cloud.compute.v1

Class AWSV4Signature.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

com.google.cloud.compute.v1.AWSV4Signature.Builder

All Implemented Interfaces:

AWSV4SignatureOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

AWSV4Signature

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

Method Summary

Modifier and Type	Method and Description
AWSV4Signature.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AWSV4Signature	build()
AWSV4Signature	buildPartial()
AWSV4Signature.Builder	clear()
AWSV4Signature.Builder	clearAccessKey() The access key used for s3 bucket authentication.
AWSV4Signature.Builder	clearAccessKeyId() The identifier of an access key used for s3 bucket authentication.
AWSV4Signature.Builder	clearAccessKeyVersion() The optional version identifier for the access key.
AWSV4Signature.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AWSV4Signature.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AWSV4Signature.Builder	clearOriginRegion() The name of the cloud region of your origin.
AWSV4Signature.Builder	clone()
String	getAccessKey() The access key used for s3 bucket authentication.
com.google.protobuf.ByteString	getAccessKeyBytes() The access key used for s3 bucket authentication.
String	getAccessKeyId() The identifier of an access key used for s3 bucket authentication.
com.google.protobuf.ByteString	getAccessKeyIdBytes() The identifier of an access key used for s3 bucket authentication.
String	getAccessKeyVersion() The optional version identifier for the access key.
com.google.protobuf.ByteString	getAccessKeyVersionBytes() The optional version identifier for the access key.
AWSV4Signature	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getOriginRegion() The name of the cloud region of your origin.
com.google.protobuf.ByteString	getOriginRegionBytes() The name of the cloud region of your origin.
boolean	hasAccessKey() The access key used for s3 bucket authentication.
boolean	hasAccessKeyId() The identifier of an access key used for s3 bucket authentication.
boolean	hasAccessKeyVersion() The optional version identifier for the access key.
boolean	hasOriginRegion() The name of the cloud region of your origin.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
AWSV4Signature.Builder	mergeFrom(AWSV4Signature other)
AWSV4Signature.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AWSV4Signature.Builder	mergeFrom(com.google.protobuf.Message other)
AWSV4Signature.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AWSV4Signature.Builder	setAccessKey(String value) The access key used for s3 bucket authentication.
AWSV4Signature.Builder	setAccessKeyBytes(com.google.protobuf.ByteString value) The access key used for s3 bucket authentication.
AWSV4Signature.Builder	setAccessKeyId(String value) The identifier of an access key used for s3 bucket authentication.
AWSV4Signature.Builder	setAccessKeyIdBytes(com.google.protobuf.ByteString value) The identifier of an access key used for s3 bucket authentication.
AWSV4Signature.Builder	setAccessKeyVersion(String value) The optional version identifier for the access key.
AWSV4Signature.Builder	setAccessKeyVersionBytes(com.google.protobuf.ByteString value) The optional version identifier for the access key.
AWSV4Signature.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AWSV4Signature.Builder	setOriginRegion(String value) The name of the cloud region of your origin.
AWSV4Signature.Builder	setOriginRegionBytes(com.google.protobuf.ByteString value) The name of the cloud region of your origin.
AWSV4Signature.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
AWSV4Signature.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

clear

public AWSV4Signature.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

getDefaultInstanceForType

public AWSV4Signature getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public AWSV4Signature build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public AWSV4Signature buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public AWSV4Signature.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

clearField

public AWSV4Signature.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

clearOneof

public AWSV4Signature.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

mergeFrom

public AWSV4Signature.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AWSV4Signature.Builder>

mergeFrom

public AWSV4Signature.Builder mergeFrom(AWSV4Signature other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

mergeFrom

public AWSV4Signature.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AWSV4Signature.Builder>

Throws:

IOException

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;

Specified by:

hasAccessKey in interface AWSV4SignatureOrBuilder

Returns:

Whether the accessKey field is set.

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;

Specified by:

getAccessKey in interface AWSV4SignatureOrBuilder

Returns:

The accessKey.

getAccessKeyBytes

public com.google.protobuf.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;

Specified by:

getAccessKeyBytes in interface AWSV4SignatureOrBuilder

Returns:

The bytes for accessKey.

setAccessKey

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;

Parameters:

value - The accessKey to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setAccessKeyBytes

public AWSV4Signature.Builder setAccessKeyBytes(com.google.protobuf.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;

Parameters:

value - The bytes for accessKey to set.

Returns:

This builder for chaining.

hasAccessKeyId

public boolean hasAccessKeyId()

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

optional string access_key_id = 292975158;

Specified by:

hasAccessKeyId in interface AWSV4SignatureOrBuilder

Returns:

Whether the accessKeyId field is set.

getAccessKeyId

public String getAccessKeyId()

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

optional string access_key_id = 292975158;

Specified by:

getAccessKeyId in interface AWSV4SignatureOrBuilder

Returns:

The accessKeyId.

getAccessKeyIdBytes

public com.google.protobuf.ByteString getAccessKeyIdBytes()

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

optional string access_key_id = 292975158;

Specified by:

getAccessKeyIdBytes in interface AWSV4SignatureOrBuilder

Returns:

The bytes for accessKeyId.

setAccessKeyId

public AWSV4Signature.Builder setAccessKeyId(String value)

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

optional string access_key_id = 292975158;

Parameters:

value - The accessKeyId to set.

Returns:

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:

This builder for chaining.

setAccessKeyIdBytes

public AWSV4Signature.Builder setAccessKeyIdBytes(com.google.protobuf.ByteString value)

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

optional string access_key_id = 292975158;

Parameters:

value - The bytes for accessKeyId to set.

Returns:

This builder for chaining.

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;

Specified by:

hasAccessKeyVersion in interface AWSV4SignatureOrBuilder

Returns:

Whether the accessKeyVersion field is set.

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;

Specified by:

getAccessKeyVersion in interface AWSV4SignatureOrBuilder

Returns:

The accessKeyVersion.

getAccessKeyVersionBytes

public com.google.protobuf.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;

Specified by:

getAccessKeyVersionBytes in interface AWSV4SignatureOrBuilder

Returns:

The bytes for accessKeyVersion.

setAccessKeyVersion

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;

Parameters:

value - The accessKeyVersion to set.

Returns:

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:

This builder for chaining.

setAccessKeyVersionBytes

public AWSV4Signature.Builder setAccessKeyVersionBytes(com.google.protobuf.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;

Parameters:

value - The bytes for accessKeyVersion to set.

Returns:

This builder for chaining.

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;

Specified by:

hasOriginRegion in interface AWSV4SignatureOrBuilder

Returns:

Whether the originRegion field is set.

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;

Specified by:

getOriginRegion in interface AWSV4SignatureOrBuilder

Returns:

The originRegion.

getOriginRegionBytes

public com.google.protobuf.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;

Specified by:

getOriginRegionBytes in interface AWSV4SignatureOrBuilder

Returns:

The bytes for originRegion.

setOriginRegion

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;

Parameters:

value - The originRegion to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setOriginRegionBytes

public AWSV4Signature.Builder setOriginRegionBytes(com.google.protobuf.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;

Parameters:

value - The bytes for originRegion to set.

Returns:

This builder for chaining.

setUnknownFields

public final AWSV4Signature.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>

mergeUnknownFields

public final AWSV4Signature.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AWSV4Signature.Builder>