Package com.google.cloud.compute.v1

Class AWSV4Signature

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.AWSV4Signature
All Implemented Interfaces:
AWSV4SignatureOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AWSV4Signature extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AWSV4Signature.Builder
    Messages Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACCESS_KEY_FIELD_NUMBER
     
    static final int
    ACCESS_KEY_ID_FIELD_NUMBER
     
    static final int
    ACCESS_KEY_VERSION_FIELD_NUMBER
     
    static final int
    ORIGIN_REGION_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    static AWSV4Signature
    getDefaultInstance()
     
    AWSV4Signature
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<AWSV4Signature>
    getParserForType()
     
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    boolean
    hasOriginRegion()
    The name of the cloud region of your origin.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static AWSV4Signature.Builder
    newBuilder()
     
    static AWSV4Signature.Builder
    newBuilder(AWSV4Signature prototype)
     
    AWSV4Signature.Builder
    newBuilderForType()
     
    protected AWSV4Signature.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static AWSV4Signature
    parseDelimitedFrom(InputStream input)
     
    static AWSV4Signature
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AWSV4Signature
    parseFrom(byte[] data)
     
    static AWSV4Signature
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AWSV4Signature
    parseFrom(com.google.protobuf.ByteString data)
     
    static AWSV4Signature
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AWSV4Signature
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AWSV4Signature
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AWSV4Signature
    parseFrom(InputStream input)
     
    static AWSV4Signature
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AWSV4Signature
    parseFrom(ByteBuffer data)
     
    static AWSV4Signature
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AWSV4Signature>
    parser()
     
    AWSV4Signature.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • ACCESS_KEY_FIELD_NUMBER

      public static final int ACCESS_KEY_FIELD_NUMBER
      See Also:

    • ACCESS_KEY_ID_FIELD_NUMBER

      public static final int ACCESS_KEY_ID_FIELD_NUMBER
      See Also:

    • ACCESS_KEY_VERSION_FIELD_NUMBER

      public static final int ACCESS_KEY_VERSION_FIELD_NUMBER
      See Also:

    • ORIGIN_REGION_FIELD_NUMBER

      public static final int ORIGIN_REGION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.

    • 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.

    • 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.

    • 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.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static AWSV4Signature parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AWSV4Signature parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AWSV4Signature parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AWSV4Signature parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AWSV4Signature parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AWSV4Signature parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AWSV4Signature parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AWSV4Signature parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AWSV4Signature parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AWSV4Signature parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AWSV4Signature parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AWSV4Signature parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public AWSV4Signature.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static AWSV4Signature.Builder newBuilder()

    • newBuilder

      public static AWSV4Signature.Builder newBuilder(AWSV4Signature prototype)

    • toBuilder

      public AWSV4Signature.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected AWSV4Signature.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AWSV4Signature getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AWSV4Signature> parser()

    • getParserForType

      public com.google.protobuf.Parser<AWSV4Signature> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public AWSV4Signature getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder