public final class ListBackupsRequest extends GeneratedMessageV3 implements ListBackupsRequestOrBuilder
The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].Protobuf type
google.spanner.admin.database.v1.ListBackupsRequest| Modifier and Type | Class and Description |
|---|---|
static class |
ListBackupsRequest.Builder
The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameterAbstractMessageLite.InternalOneOfEnum| Modifier and Type | Field and Description |
|---|---|
static int |
FILTER_FIELD_NUMBER |
static int |
PAGE_SIZE_FIELD_NUMBER |
static int |
PAGE_TOKEN_FIELD_NUMBER |
static int |
PARENT_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCodecanUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int PARENT_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class GeneratedMessageV3public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public String getParent()
Required. The instance to list backups from. Values are of the form `projects/<project>/instances/<instance>`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParent in interface ListBackupsRequestOrBuilderpublic ByteString getParentBytes()
Required. The instance to list backups from. Values are of the form `projects/<project>/instances/<instance>`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParentBytes in interface ListBackupsRequestOrBuilderpublic String getFilter()
An expression that filters the list of returned backups.
A filter expression consists of a field name, a comparison operator, and a
value for filtering.
The value must be a string, a number, or a boolean. The comparison operator
must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
Colon `:` is the contains operator. Filter rules are not case sensitive.
The following fields in the [Backup][google.spanner.admin.database.v1.Backup] are eligible for filtering:
* `name`
* `database`
* `state`
* `create_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)
* `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
* `size_bytes`
You can combine multiple expressions by enclosing each expression in
parentheses. By default, expressions are combined with AND logic, but
you can specify AND, OR, and NOT logic explicitly.
Here are a few examples:
* `name:Howl` - The backup's name contains the string "howl".
* `database:prod`
- The database'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 (create_time < \"2018-03-28T14:50:00Z\")`
- The backup name contains the string "howl" and `create_time`
of the backup is before 2018-03-28T14:50:00Z.
* `expire_time < \"2018-03-28T14:50:00Z\"`
- The backup `expire_time` is before 2018-03-28T14:50:00Z.
* `size_bytes > 10000000000` - The backup's size is greater than 10GB
string filter = 2;getFilter in interface ListBackupsRequestOrBuilderpublic ByteString getFilterBytes()
An expression that filters the list of returned backups.
A filter expression consists of a field name, a comparison operator, and a
value for filtering.
The value must be a string, a number, or a boolean. The comparison operator
must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
Colon `:` is the contains operator. Filter rules are not case sensitive.
The following fields in the [Backup][google.spanner.admin.database.v1.Backup] are eligible for filtering:
* `name`
* `database`
* `state`
* `create_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)
* `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
* `size_bytes`
You can combine multiple expressions by enclosing each expression in
parentheses. By default, expressions are combined with AND logic, but
you can specify AND, OR, and NOT logic explicitly.
Here are a few examples:
* `name:Howl` - The backup's name contains the string "howl".
* `database:prod`
- The database'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 (create_time < \"2018-03-28T14:50:00Z\")`
- The backup name contains the string "howl" and `create_time`
of the backup is before 2018-03-28T14:50:00Z.
* `expire_time < \"2018-03-28T14:50:00Z\"`
- The backup `expire_time` is before 2018-03-28T14:50:00Z.
* `size_bytes > 10000000000` - The backup's size is greater than 10GB
string filter = 2;getFilterBytes in interface ListBackupsRequestOrBuilderpublic 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 = 3;getPageSize in interface ListBackupsRequestOrBuilderpublic String getPageToken()
If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same `filter`.
string page_token = 4;getPageToken in interface ListBackupsRequestOrBuilderpublic ByteString getPageTokenBytes()
If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same `filter`.
string page_token = 4;getPageTokenBytes in interface ListBackupsRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static ListBackupsRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListBackupsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListBackupsRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListBackupsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListBackupsRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListBackupsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListBackupsRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ListBackupsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ListBackupsRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ListBackupsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ListBackupsRequest parseFrom(CodedInputStream input) throws IOException
IOExceptionpublic static ListBackupsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ListBackupsRequest.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static ListBackupsRequest.Builder newBuilder()
public static ListBackupsRequest.Builder newBuilder(ListBackupsRequest prototype)
public ListBackupsRequest.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected ListBackupsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static ListBackupsRequest getDefaultInstance()
public static Parser<ListBackupsRequest> parser()
public Parser<ListBackupsRequest> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public ListBackupsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.