final case class ListBackupsRequest(parent: String = "", filter: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListBackupsRequest] with Product with Serializable

The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].

parent

Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.

filter

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) * 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 < &92;"2018-03-28T14:50:00Z&92;")
  • The backup name contains the string "howl" and create_time of the backup is before 2018-03-28T14:50:00Z. * expire_time < &92;"2018-03-28T14:50:00Z&92;"
  • The backup expire_time is before 2018-03-28T14:50:00Z. * size_bytes > 10000000000 - The backup's size is greater than 10GB
pageSize

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

pageToken

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.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[ListBackupsRequest], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ListBackupsRequest
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ListBackupsRequest(parent: String = "", filter: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...)

    parent

    Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.

    filter

    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) * 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 < &92;"2018-03-28T14:50:00Z&92;")
    • The backup name contains the string "howl" and create_time of the backup is before 2018-03-28T14:50:00Z. * expire_time < &92;"2018-03-28T14:50:00Z&92;"
    • The backup expire_time is before 2018-03-28T14:50:00Z. * size_bytes > 10000000000 - The backup's size is greater than 10GB
    pageSize

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

    pageToken

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def companion: ListBackupsRequest.type
    Definition Classes
    ListBackupsRequest → GeneratedMessage
  7. def discardUnknownFields: ListBackupsRequest
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val filter: String
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ListBackupsRequest → GeneratedMessage
  13. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ListBackupsRequest → GeneratedMessage
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. val pageSize: Int
  19. val pageToken: String
  20. val parent: String
  21. def serializedSize: Int
    Definition Classes
    ListBackupsRequest → GeneratedMessage
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  24. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  25. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  26. def toProtoString: String
    Definition Classes
    ListBackupsRequest → GeneratedMessage
  27. val unknownFields: UnknownFieldSet
  28. def update(ms: (Lens[ListBackupsRequest, ListBackupsRequest]) ⇒ Mutation[ListBackupsRequest]*): ListBackupsRequest
    Definition Classes
    Updatable
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. def withFilter(__v: String): ListBackupsRequest
  33. def withPageSize(__v: Int): ListBackupsRequest
  34. def withPageToken(__v: String): ListBackupsRequest
  35. def withParent(__v: String): ListBackupsRequest
  36. def withUnknownFields(__v: UnknownFieldSet): ListBackupsRequest
  37. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  38. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ListBackupsRequest → GeneratedMessage
  39. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[ListBackupsRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped