Method: googleapis.spanner.v1.projects.instances.instancePartitions.list

Lists all instance partitions for the given instance.

For more information about retries and long-running operations, see Understand connectors.

Arguments

Parameters
parent

string

Required. The instance whose instance partitions should be listed. Values are of the form projects//instances/. Use {instance} = '-' to list instance partitions for all Instances in a project, e.g., projects/myproject/instances/-.
instancePartitionDeadline

string (Timestamp format)

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.
pageSize

integer (int32 format)

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

string

If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionsResponse.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of ListInstancePartitionsResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.spanner.v1.projects.instances.instancePartitions.list
    args:
        parent: ...
        instancePartitionDeadline: ...
        pageSize: ...
        pageToken: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.spanner.v1.projects.instances.instancePartitions.list",
      "args": {
        "parent": "...",
        "instancePartitionDeadline": "...",
        "pageSize": "...",
        "pageToken": "..."
      },
      "result": "listResult"
    }
  }
]