Struct ListDatabaseOperationsRequest

#[non_exhaustive]
pub struct ListDatabaseOperationsRequest {
    pub parent: String,
    pub filter: String,
    pub page_size: i32,
    pub page_token: String,
}

The request for ListDatabaseOperations.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

parent: String

Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.

filter: String

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.

page_size: i32

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

page_token: String

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

Implementations

impl ListDatabaseOperationsRequest

pub fn new() -> Self

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Trait Implementations

impl Clone for ListDatabaseOperationsRequest

fn clone(&self) -> ListDatabaseOperationsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListDatabaseOperationsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListDatabaseOperationsRequest

fn default() -> ListDatabaseOperationsRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListDatabaseOperationsRequest

where ListDatabaseOperationsRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ListDatabaseOperationsRequest

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for ListDatabaseOperationsRequest

fn eq(&self, other: &ListDatabaseOperationsRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ListDatabaseOperationsRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ListDatabaseOperationsRequest