public final class ListDatabaseOperationsRequest extends GeneratedMessageV3 implements ListDatabaseOperationsRequestOrBuilder
The request for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].Protobuf type
google.spanner.admin.database.v1.ListDatabaseOperationsRequest| Modifier and Type | Class and Description |
|---|---|
static class |
ListDatabaseOperationsRequest.Builder
The request for
[ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].
|
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 of the database operations. Values are of the form `projects/<project>/instances/<instance>`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParent in interface ListDatabaseOperationsRequestOrBuilderpublic ByteString getParentBytes()
Required. The instance of the database operations. Values are of the form `projects/<project>/instances/<instance>`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParentBytes in interface ListDatabaseOperationsRequestOrBuilderpublic String getFilter()
An expression that filters the list of returned operations.
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 [Operation][google.longrunning.Operation]
are eligible for filtering:
* `name` - The name of the long-running operation
* `done` - False if the operation is in progress, else true.
* `metadata.@type` - the type of metadata. For example, the type string
for [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata] is
`type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
* `metadata.<field_name>` - any field in metadata.value.
`metadata.@type` must be specified first, if filtering on metadata
fields.
* `error` - Error associated with the long-running operation.
* `response.@type` - the type of response.
* `response.<field_name>` - any field in response.value.
You can combine multiple expressions by enclosing each expression in
parentheses. By default, expressions are combined with AND logic. However,
you can specify AND, OR, and NOT logic explicitly.
Here are a few examples:
* `done:true` - The operation is complete.
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
`(metadata.source_type:BACKUP) AND` \
`(metadata.backup_info.backup:backup_howl) AND` \
`(metadata.name:restored_howl) AND` \
`(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
`(error:*)` - Return operations where:
* The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* The database is restored from a backup.
* The backup name contains "backup_howl".
* The restored database's name contains "restored_howl".
* The operation started before 2018-03-28T14:50:00Z.
* The operation resulted in an error.
string filter = 2;getFilter in interface ListDatabaseOperationsRequestOrBuilderpublic ByteString getFilterBytes()
An expression that filters the list of returned operations.
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 [Operation][google.longrunning.Operation]
are eligible for filtering:
* `name` - The name of the long-running operation
* `done` - False if the operation is in progress, else true.
* `metadata.@type` - the type of metadata. For example, the type string
for [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata] is
`type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
* `metadata.<field_name>` - any field in metadata.value.
`metadata.@type` must be specified first, if filtering on metadata
fields.
* `error` - Error associated with the long-running operation.
* `response.@type` - the type of response.
* `response.<field_name>` - any field in response.value.
You can combine multiple expressions by enclosing each expression in
parentheses. By default, expressions are combined with AND logic. However,
you can specify AND, OR, and NOT logic explicitly.
Here are a few examples:
* `done:true` - The operation is complete.
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
`(metadata.source_type:BACKUP) AND` \
`(metadata.backup_info.backup:backup_howl) AND` \
`(metadata.name:restored_howl) AND` \
`(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
`(error:*)` - Return operations where:
* The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* The database is restored from a backup.
* The backup name contains "backup_howl".
* The restored database's name contains "restored_howl".
* The operation started before 2018-03-28T14:50:00Z.
* The operation resulted in an error.
string filter = 2;getFilterBytes in interface ListDatabaseOperationsRequestOrBuilderpublic int getPageSize()
Number of operations 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 ListDatabaseOperationsRequestOrBuilderpublic String getPageToken()
If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabaseOperationsResponse.next_page_token] from a previous [ListDatabaseOperationsResponse][google.spanner.admin.database.v1.ListDatabaseOperationsResponse] to the same `parent` and with the same `filter`.
string page_token = 4;getPageToken in interface ListDatabaseOperationsRequestOrBuilderpublic ByteString getPageTokenBytes()
If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabaseOperationsResponse.next_page_token] from a previous [ListDatabaseOperationsResponse][google.spanner.admin.database.v1.ListDatabaseOperationsResponse] to the same `parent` and with the same `filter`.
string page_token = 4;getPageTokenBytes in interface ListDatabaseOperationsRequestOrBuilderpublic 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 ListDatabaseOperationsRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListDatabaseOperationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListDatabaseOperationsRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListDatabaseOperationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListDatabaseOperationsRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListDatabaseOperationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static ListDatabaseOperationsRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ListDatabaseOperationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ListDatabaseOperationsRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ListDatabaseOperationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ListDatabaseOperationsRequest parseFrom(CodedInputStream input) throws IOException
IOExceptionpublic static ListDatabaseOperationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ListDatabaseOperationsRequest.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static ListDatabaseOperationsRequest.Builder newBuilder()
public static ListDatabaseOperationsRequest.Builder newBuilder(ListDatabaseOperationsRequest prototype)
public ListDatabaseOperationsRequest.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected ListDatabaseOperationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static ListDatabaseOperationsRequest getDefaultInstance()
public static Parser<ListDatabaseOperationsRequest> parser()
public Parser<ListDatabaseOperationsRequest> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public ListDatabaseOperationsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.