get(name, x__xgafv=None)

Gets information about a particular instance configuration.

Args:
  name: string, Required. The name of the requested instance configuration. Values are of the form `projects//instanceConfigs/`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
  "displayName": "A String", # The name of this instance configuration as it appears in UIs.
  "leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
    "A String",
  ],
  "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.
  "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties.
    {
      "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
      "location": "A String", # The location of the serving resources, e.g. "us-central1".
      "type": "A String", # The type of replica.
    },
  ],
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists the supported instance configurations for a given project.

Args:
  parent: string, Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`. (required)
  pageSize: integer, Number of instance configurations 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 ListInstanceConfigsResponse.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for ListInstanceConfigs.
  "instanceConfigs": [ # The list of requested instance configurations.
    { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
      "displayName": "A String", # The name of this instance configuration as it appears in UIs.
      "leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
        "A String",
      ],
      "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.
      "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties.
        {
          "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
          "location": "A String", # The location of the serving resources, e.g. "us-central1".
          "type": "A String", # The type of replica.
        },
      ],
    },
  ],
  "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

Cloud Spanner API . projects . instanceConfigs

Instance Methods

Method Details