Package com.google.bigtable.admin.v2

Class Snapshot.Builder

  • All Implemented Interfaces:
    SnapshotOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Snapshot
    public static final class Snapshot.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>
implements SnapshotOrBuilder
     A snapshot of a table at a particular time. A snapshot can be used as a
 checkpoint for data restoration or a data source for a new table.

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

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

      • clear

        public Snapshot.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<Snapshot.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<Snapshot.Builder>

      • getDefaultInstanceForType

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

      • build

        public Snapshot build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Snapshot buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Snapshot.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<Snapshot.Builder>

      • setField

        public Snapshot.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<Snapshot.Builder>

      • clearField

        public Snapshot.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<Snapshot.Builder>

      • clearOneof

        public Snapshot.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<Snapshot.Builder>

      • setRepeatedField

        public Snapshot.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<Snapshot.Builder>

      • addRepeatedField

        public Snapshot.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<Snapshot.Builder>

      • mergeFrom

        public Snapshot.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<Snapshot.Builder>

      • isInitialized

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

      • mergeFrom

        public Snapshot.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<Snapshot.Builder>
        Throws:
        IOException

      • getName

        public String getName()
         The unique name of the snapshot.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
        string name = 1;
        Specified by:
        getName in interface SnapshotOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The unique name of the snapshot.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
        string name = 1;
        Specified by:
        getNameBytes in interface SnapshotOrBuilder
        Returns:
        The bytes for name.

      • setName

        public Snapshot.Builder setName​(String value)
         The unique name of the snapshot.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
        string name = 1;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Snapshot.Builder clearName()
         The unique name of the snapshot.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
        string name = 1;
        Returns:
        This builder for chaining.

      • setNameBytes

        public Snapshot.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The unique name of the snapshot.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
        string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • hasSourceTable

        public boolean hasSourceTable()
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasSourceTable in interface SnapshotOrBuilder
        Returns:
        Whether the sourceTable field is set.

      • getSourceTable

        public Table getSourceTable()
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSourceTable in interface SnapshotOrBuilder
        Returns:
        The sourceTable.

      • setSourceTable

        public Snapshot.Builder setSourceTable​(Table value)
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setSourceTable

        public Snapshot.Builder setSourceTable​(Table.Builder builderForValue)
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeSourceTable

        public Snapshot.Builder mergeSourceTable​(Table value)
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearSourceTable

        public Snapshot.Builder clearSourceTable()
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getSourceTableBuilder

        public Table.Builder getSourceTableBuilder()
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getSourceTableOrBuilder

        public TableOrBuilder getSourceTableOrBuilder()
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSourceTableOrBuilder in interface SnapshotOrBuilder

      • getDataSizeBytes

        public long getDataSizeBytes()
         Output only. The size of the data in the source table at the time the
 snapshot was taken. In some cases, this value may be computed
 asynchronously via a background process and a placeholder of 0 will be used
 in the meantime.
        int64 data_size_bytes = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataSizeBytes in interface SnapshotOrBuilder
        Returns:
        The dataSizeBytes.

      • setDataSizeBytes

        public Snapshot.Builder setDataSizeBytes​(long value)
         Output only. The size of the data in the source table at the time the
 snapshot was taken. In some cases, this value may be computed
 asynchronously via a background process and a placeholder of 0 will be used
 in the meantime.
        int64 data_size_bytes = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The dataSizeBytes to set.
        Returns:
        This builder for chaining.

      • clearDataSizeBytes

        public Snapshot.Builder clearDataSizeBytes()
         Output only. The size of the data in the source table at the time the
 snapshot was taken. In some cases, this value may be computed
 asynchronously via a background process and a placeholder of 0 will be used
 in the meantime.
        int64 data_size_bytes = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface SnapshotOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface SnapshotOrBuilder
        Returns:
        The createTime.

      • setCreateTime

        public Snapshot.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setCreateTime

        public Snapshot.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeCreateTime

        public Snapshot.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearCreateTime

        public Snapshot.Builder clearCreateTime()
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface SnapshotOrBuilder

      • hasDeleteTime

        public boolean hasDeleteTime()
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;
        Specified by:
        hasDeleteTime in interface SnapshotOrBuilder
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        public com.google.protobuf.Timestamp getDeleteTime()
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;
        Specified by:
        getDeleteTime in interface SnapshotOrBuilder
        Returns:
        The deleteTime.

      • setDeleteTime

        public Snapshot.Builder setDeleteTime​(com.google.protobuf.Timestamp value)
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;

      • setDeleteTime

        public Snapshot.Builder setDeleteTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;

      • mergeDeleteTime

        public Snapshot.Builder mergeDeleteTime​(com.google.protobuf.Timestamp value)
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;

      • clearDeleteTime

        public Snapshot.Builder clearDeleteTime()
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;

      • getDeleteTimeBuilder

        public com.google.protobuf.Timestamp.Builder getDeleteTimeBuilder()
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;

      • getDeleteTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;
        Specified by:
        getDeleteTimeOrBuilder in interface SnapshotOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. The current state of the snapshot.
        .google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface SnapshotOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • setStateValue

        public Snapshot.Builder setStateValue​(int value)
         Output only. The current state of the snapshot.
        .google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for state to set.
        Returns:
        This builder for chaining.

      • getState

        public Snapshot.State getState()
         Output only. The current state of the snapshot.
        .google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface SnapshotOrBuilder
        Returns:
        The state.

      • setState

        public Snapshot.Builder setState​(Snapshot.State value)
         Output only. The current state of the snapshot.
        .google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The state to set.
        Returns:
        This builder for chaining.

      • clearState

        public Snapshot.Builder clearState()
         Output only. The current state of the snapshot.
        .google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • getDescription

        public String getDescription()
         Description of the snapshot.
        string description = 7;
        Specified by:
        getDescription in interface SnapshotOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

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

      • setDescription

        public Snapshot.Builder setDescription​(String value)
         Description of the snapshot.
        string description = 7;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public Snapshot.Builder clearDescription()
         Description of the snapshot.
        string description = 7;
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public Snapshot.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         Description of the snapshot.
        string description = 7;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Snapshot.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<Snapshot.Builder>

      • mergeUnknownFields

        public final Snapshot.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<Snapshot.Builder>