Package com.google.bigtable.admin.v2

Class SnapshotTableRequest

  • All Implemented Interfaces:
    SnapshotTableRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SnapshotTableRequest
extends com.google.protobuf.GeneratedMessageV3
implements SnapshotTableRequestOrBuilder
     Request message for
 [google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable]

 Note: This is a private alpha release of Cloud Bigtable snapshots. This
 feature is not currently available to most Cloud Bigtable customers. This
 feature might be changed in backward-incompatible ways and is not recommended
 for production use. It is not subject to any SLA or deprecation policy.
    Protobuf type google.bigtable.admin.v2.SnapshotTableRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SnapshotTableRequest.Builder
      Request message for [google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable] Note: This is a private alpha release of Cloud Bigtable snapshots.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • getName

        public String getName()
         Required. The unique name of the table to have the snapshot taken.
 Values are of the form
 `projects/{project}/instances/{instance}/tables/{table}`.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface SnapshotTableRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The unique name of the table to have the snapshot taken.
 Values are of the form
 `projects/{project}/instances/{instance}/tables/{table}`.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface SnapshotTableRequestOrBuilder
        Returns:
        The bytes for name.

      • getCluster

        public String getCluster()
         Required. The name of the cluster where the snapshot will be created in.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}`.
        string cluster = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getCluster in interface SnapshotTableRequestOrBuilder
        Returns:
        The cluster.

      • getClusterBytes

        public com.google.protobuf.ByteString getClusterBytes()
         Required. The name of the cluster where the snapshot will be created in.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}`.
        string cluster = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getClusterBytes in interface SnapshotTableRequestOrBuilder
        Returns:
        The bytes for cluster.

      • getSnapshotId

        public String getSnapshotId()
         Required. The ID by which the new snapshot should be referred to within the
 parent cluster, e.g., `mysnapshot` of the form:
 `[_a-zA-Z0-9][-_.a-zA-Z0-9]*` rather than
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
        string snapshot_id = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSnapshotId in interface SnapshotTableRequestOrBuilder
        Returns:
        The snapshotId.

      • getSnapshotIdBytes

        public com.google.protobuf.ByteString getSnapshotIdBytes()
         Required. The ID by which the new snapshot should be referred to within the
 parent cluster, e.g., `mysnapshot` of the form:
 `[_a-zA-Z0-9][-_.a-zA-Z0-9]*` rather than
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
        string snapshot_id = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSnapshotIdBytes in interface SnapshotTableRequestOrBuilder
        Returns:
        The bytes for snapshotId.

      • hasTtl

        public boolean hasTtl()
         The amount of time that the new snapshot can stay active after it is
 created. Once 'ttl' expires, the snapshot will get deleted. The maximum
 amount of time a snapshot can stay active is 7 days. If 'ttl' is not
 specified, the default value of 24 hours will be used.
        .google.protobuf.Duration ttl = 4;
        Specified by:
        hasTtl in interface SnapshotTableRequestOrBuilder
        Returns:
        Whether the ttl field is set.

      • getTtl

        public com.google.protobuf.Duration getTtl()
         The amount of time that the new snapshot can stay active after it is
 created. Once 'ttl' expires, the snapshot will get deleted. The maximum
 amount of time a snapshot can stay active is 7 days. If 'ttl' is not
 specified, the default value of 24 hours will be used.
        .google.protobuf.Duration ttl = 4;
        Specified by:
        getTtl in interface SnapshotTableRequestOrBuilder
        Returns:
        The ttl.

      • getTtlOrBuilder

        public com.google.protobuf.DurationOrBuilder getTtlOrBuilder()
         The amount of time that the new snapshot can stay active after it is
 created. Once 'ttl' expires, the snapshot will get deleted. The maximum
 amount of time a snapshot can stay active is 7 days. If 'ttl' is not
 specified, the default value of 24 hours will be used.
        .google.protobuf.Duration ttl = 4;
        Specified by:
        getTtlOrBuilder in interface SnapshotTableRequestOrBuilder

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Description of the snapshot.
        string description = 5;
        Specified by:
        getDescriptionBytes in interface SnapshotTableRequestOrBuilder
        Returns:
        The bytes for description.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 SnapshotTableRequest parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected SnapshotTableRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SnapshotTableRequest> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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