Package com.google.bigtable.admin.v2

Class SnapshotTableRequest.Builder

  • All Implemented Interfaces:
    SnapshotTableRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    SnapshotTableRequest
    public static final class SnapshotTableRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SnapshotTableRequest.Builder>
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

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • isInitialized

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

      • mergeFrom

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

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

      • setName

        public SnapshotTableRequest.Builder setName​(String value)
         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) = { ... }
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public SnapshotTableRequest.Builder clearName()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setNameBytes

        public SnapshotTableRequest.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

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

      • setCluster

        public SnapshotTableRequest.Builder setCluster​(String value)
         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) = { ... }
        Parameters:
        value - The cluster to set.
        Returns:
        This builder for chaining.

      • clearCluster

        public SnapshotTableRequest.Builder clearCluster()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setClusterBytes

        public SnapshotTableRequest.Builder setClusterBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for cluster to set.
        Returns:
        This builder for chaining.

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

      • setSnapshotId

        public SnapshotTableRequest.Builder setSnapshotId​(String value)
         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];
        Parameters:
        value - The snapshotId to set.
        Returns:
        This builder for chaining.

      • clearSnapshotId

        public SnapshotTableRequest.Builder clearSnapshotId()
         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];
        Returns:
        This builder for chaining.

      • setSnapshotIdBytes

        public SnapshotTableRequest.Builder setSnapshotIdBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for snapshotId to set.
        Returns:
        This builder for chaining.

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

      • setTtl

        public SnapshotTableRequest.Builder setTtl​(com.google.protobuf.Duration value)
         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;

      • setTtl

        public SnapshotTableRequest.Builder setTtl​(com.google.protobuf.Duration.Builder builderForValue)
         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;

      • mergeTtl

        public SnapshotTableRequest.Builder mergeTtl​(com.google.protobuf.Duration value)
         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;

      • clearTtl

        public SnapshotTableRequest.Builder clearTtl()
         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;

      • getTtlBuilder

        public com.google.protobuf.Duration.Builder getTtlBuilder()
         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;

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

      • setDescription

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

      • clearDescription

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

      • setDescriptionBytes

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

      • setUnknownFields

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

      • mergeUnknownFields

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