Class ListDatabaseOperationsRequest (6.89.0)

publicfinalclassListDatabaseOperationsRequestextendsGeneratedMessageV3implementsListDatabaseOperationsRequestOrBuilder

The request for ListDatabaseOperations.

Protobuf type google.spanner.admin.database.v1.ListDatabaseOperationsRequest

Static Fields

FILTER_FIELD_NUMBER

publicstaticfinalintFILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

publicstaticfinalintPAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

publicstaticfinalintPAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

publicstaticfinalintPARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticListDatabaseOperationsRequestgetDefaultInstance()
Returns
TypeDescription
ListDatabaseOperationsRequest

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticListDatabaseOperationsRequest.BuildernewBuilder()
Returns
TypeDescription
ListDatabaseOperationsRequest.Builder

newBuilder(ListDatabaseOperationsRequest prototype)

publicstaticListDatabaseOperationsRequest.BuildernewBuilder(ListDatabaseOperationsRequestprototype)
Parameter
NameDescription
prototypeListDatabaseOperationsRequest
Returns
TypeDescription
ListDatabaseOperationsRequest.Builder

parseDelimitedFrom(InputStream input)

publicstaticListDatabaseOperationsRequestparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListDatabaseOperationsRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticListDatabaseOperationsRequestparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticListDatabaseOperationsRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticListDatabaseOperationsRequestparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticListDatabaseOperationsRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticListDatabaseOperationsRequestparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListDatabaseOperationsRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticListDatabaseOperationsRequestparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListDatabaseOperationsRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticListDatabaseOperationsRequestparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticListDatabaseOperationsRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDatabaseOperationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<ListDatabaseOperationsRequest>parser()
Returns
TypeDescription
Parser<ListDatabaseOperationsRequest>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

publicListDatabaseOperationsRequestgetDefaultInstanceForType()
Returns
TypeDescription
ListDatabaseOperationsRequest

getFilter()

publicStringgetFilter()

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

Returns
TypeDescription
String

The filter.

getFilterBytes()

publicByteStringgetFilterBytes()

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

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

publicintgetPageSize()

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;

Returns
TypeDescription
int

The pageSize.

getPageToken()

publicStringgetPageToken()

If non-empty, page_token should contain a next_page_token from a previous ListDatabaseOperationsResponse to the same parent and with the same filter.

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

publicByteStringgetPageTokenBytes()

If non-empty, page_token should contain a next_page_token from a previous ListDatabaseOperationsResponse to the same parent and with the same filter.

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

publicStringgetParent()

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) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

publicByteStringgetParentBytes()

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) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

publicParser<ListDatabaseOperationsRequest>getParserForType()
Returns
TypeDescription
Parser<ListDatabaseOperationsRequest>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicListDatabaseOperationsRequest.BuildernewBuilderForType()
Returns
TypeDescription
ListDatabaseOperationsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedListDatabaseOperationsRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListDatabaseOperationsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicListDatabaseOperationsRequest.BuildertoBuilder()
Returns
TypeDescription
ListDatabaseOperationsRequest.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException