com.google.bigtable.admin.v2

Class ListBackupsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.bigtable.admin.v2.ListBackupsRequest

All Implemented Interfaces:

ListBackupsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ListBackupsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListBackupsRequestOrBuilder

 The request for
 [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].
 

Protobuf type google.bigtable.admin.v2.ListBackupsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListBackupsRequest.Builder The request for [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	ORDER_BY_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	equals(Object obj)
static ListBackupsRequest	getDefaultInstance()
ListBackupsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() A filter expression that filters backups listed in the response.
com.google.protobuf.ByteString	getFilterBytes() A filter expression that filters backups listed in the response.
String	getOrderBy() An expression for specifying the sort order of the results of the request.
com.google.protobuf.ByteString	getOrderByBytes() An expression for specifying the sort order of the results of the request.
int	getPageSize() Number of backups to be returned in the response.
String	getPageToken() If non-empty, `page_token` should contain a [next_page_token][google.bigtable.admin.v2.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.bigtable.admin.v2.ListBackupsResponse] to the same `parent` and with the same `filter`.
com.google.protobuf.ByteString	getPageTokenBytes() If non-empty, `page_token` should contain a [next_page_token][google.bigtable.admin.v2.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.bigtable.admin.v2.ListBackupsResponse] to the same `parent` and with the same `filter`.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<ListBackupsRequest>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListBackupsRequest.Builder	newBuilder()
static ListBackupsRequest.Builder	newBuilder(ListBackupsRequest prototype)
ListBackupsRequest.Builder	newBuilderForType()
protected ListBackupsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ListBackupsRequest	parseDelimitedFrom(InputStream input)
static ListBackupsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListBackupsRequest	parseFrom(byte[] data)
static ListBackupsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListBackupsRequest	parseFrom(ByteBuffer data)
static ListBackupsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListBackupsRequest	parseFrom(com.google.protobuf.ByteString data)
static ListBackupsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListBackupsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ListBackupsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListBackupsRequest	parseFrom(InputStream input)
static ListBackupsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ListBackupsRequest>	parser()
ListBackupsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

getParent

public String getParent()

 Required. The cluster to list backups from. Values are of the
 form `projects/{project}/instances/{instance}/clusters/{cluster}`.
 Use `{cluster} = '-'` to list backups for all clusters in an instance,
 e.g., `projects/{project}/instances/{instance}/clusters/-`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParent in interface ListBackupsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The cluster to list backups from. Values are of the
 form `projects/{project}/instances/{instance}/clusters/{cluster}`.
 Use `{cluster} = '-'` to list backups for all clusters in an instance,
 e.g., `projects/{project}/instances/{instance}/clusters/-`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParentBytes in interface ListBackupsRequestOrBuilder

Returns:

The bytes for parent.

getFilter

public String getFilter()

 A filter expression that filters backups listed in the response.
 The expression must specify the field name, a comparison operator,
 and the value that you want to use for filtering. The value must be a
 string, a number, or a boolean. The comparison operator must be
 <, >, <=, >=, !=, =, or :. Colon ‘:’ represents a HAS operator which is
 roughly synonymous with equality. Filter rules are case insensitive.
 The fields eligible for filtering are:
   * `name`
   * `source_table`
   * `state`
   * `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
   * `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
   * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
   * `size_bytes`
 To filter on multiple expressions, provide each separate expression within
 parentheses. By default, each expression is an AND expression. However,
 you can include AND, OR, and NOT expressions explicitly.
 Some examples of using filters are:
   * `name:"exact"` --> The backup's name is the string "exact".
   * `name:howl` --> The backup's name contains the string "howl".
   * `source_table:prod`
          --> The source_table's name contains the string "prod".
   * `state:CREATING` --> The backup is pending creation.
   * `state:READY` --> The backup is fully created and ready for use.
   * `(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")`
          --> The backup name contains the string "howl" and start_time
              of the backup is before 2018-03-28T14:50:00Z.
   * `size_bytes > 10000000000` --> The backup's size is greater than 10GB
 

string filter = 2;

Specified by:

getFilter in interface ListBackupsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 A filter expression that filters backups listed in the response.
 The expression must specify the field name, a comparison operator,
 and the value that you want to use for filtering. The value must be a
 string, a number, or a boolean. The comparison operator must be
 <, >, <=, >=, !=, =, or :. Colon ‘:’ represents a HAS operator which is
 roughly synonymous with equality. Filter rules are case insensitive.
 The fields eligible for filtering are:
   * `name`
   * `source_table`
   * `state`
   * `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
   * `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
   * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
   * `size_bytes`
 To filter on multiple expressions, provide each separate expression within
 parentheses. By default, each expression is an AND expression. However,
 you can include AND, OR, and NOT expressions explicitly.
 Some examples of using filters are:
   * `name:"exact"` --> The backup's name is the string "exact".
   * `name:howl` --> The backup's name contains the string "howl".
   * `source_table:prod`
          --> The source_table's name contains the string "prod".
   * `state:CREATING` --> The backup is pending creation.
   * `state:READY` --> The backup is fully created and ready for use.
   * `(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")`
          --> The backup name contains the string "howl" and start_time
              of the backup is before 2018-03-28T14:50:00Z.
   * `size_bytes > 10000000000` --> The backup's size is greater than 10GB
 

string filter = 2;

Specified by:

getFilterBytes in interface ListBackupsRequestOrBuilder

Returns:

The bytes for filter.

getOrderBy

public String getOrderBy()

 An expression for specifying the sort order of the results of the request.
 The string value should specify one or more fields in
 [Backup][google.bigtable.admin.v2.Backup]. The full syntax is described at
 https://aip.dev/132#ordering.
 Fields supported are:
    * name
    * source_table
    * expire_time
    * start_time
    * end_time
    * size_bytes
    * state
 For example, "start_time". The default sorting order is ascending.
 To specify descending order for the field, a suffix " desc" should
 be appended to the field name. For example, "start_time desc".
 Redundant space characters in the syntax are insigificant.
 If order_by is empty, results will be sorted by `start_time` in descending
 order starting from the most recently created backup.
 

string order_by = 3;

Specified by:

getOrderBy in interface ListBackupsRequestOrBuilder

Returns:

The orderBy.

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

 An expression for specifying the sort order of the results of the request.
 The string value should specify one or more fields in
 [Backup][google.bigtable.admin.v2.Backup]. The full syntax is described at
 https://aip.dev/132#ordering.
 Fields supported are:
    * name
    * source_table
    * expire_time
    * start_time
    * end_time
    * size_bytes
    * state
 For example, "start_time". The default sorting order is ascending.
 To specify descending order for the field, a suffix " desc" should
 be appended to the field name. For example, "start_time desc".
 Redundant space characters in the syntax are insigificant.
 If order_by is empty, results will be sorted by `start_time` in descending
 order starting from the most recently created backup.
 

string order_by = 3;

Specified by:

getOrderByBytes in interface ListBackupsRequestOrBuilder

Returns:

The bytes for orderBy.

getPageSize

public int getPageSize()

 Number of backups to be returned in the response. If 0 or
 less, defaults to the server's maximum allowed page size.
 

int32 page_size = 4;

Specified by:

getPageSize in interface ListBackupsRequestOrBuilder

Returns:

The pageSize.

getPageToken

public String getPageToken()

 If non-empty, `page_token` should contain a
 [next_page_token][google.bigtable.admin.v2.ListBackupsResponse.next_page_token]
 from a previous
 [ListBackupsResponse][google.bigtable.admin.v2.ListBackupsResponse] to the
 same `parent` and with the same `filter`.
 

string page_token = 5;

Specified by:

getPageToken in interface ListBackupsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 If non-empty, `page_token` should contain a
 [next_page_token][google.bigtable.admin.v2.ListBackupsResponse.next_page_token]
 from a previous
 [ListBackupsResponse][google.bigtable.admin.v2.ListBackupsResponse] to the
 same `parent` and with the same `filter`.
 

string page_token = 5;

Specified by:

getPageTokenBytes in interface ListBackupsRequestOrBuilder

Returns:

The bytes for pageToken.

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 ListBackupsRequest parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListBackupsRequest parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListBackupsRequest parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListBackupsRequest parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ListBackupsRequest parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static ListBackupsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ListBackupsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ListBackupsRequest.Builder newBuilder()

newBuilder

public static ListBackupsRequest.Builder newBuilder(ListBackupsRequest prototype)

toBuilder

public ListBackupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ListBackupsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ListBackupsRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ListBackupsRequest> 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 ListBackupsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder