Cloud Bigtable Admin API . projects . instances . clusters

Instance Methods

backups()

Returns the backups Resource.

create(parent, body=None, clusterId=None, x__xgafv=None)

Creates a cluster within an instance.

delete(name, x__xgafv=None)

Deletes a cluster from an instance.

get(name, x__xgafv=None)

Gets information about a cluster.

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

Lists information about clusters in an instance.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(name, body=None, x__xgafv=None)

Updates a cluster within an instance.

Method Details

create(parent, body=None, clusterId=None, x__xgafv=None)
Creates a cluster within an instance.

Args:
  parent: string, Required. The unique name of the instance in which to create the new cluster.
Values are of the form
`projects/{project}/instances/{instance}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A resizable group of nodes in a particular cloud location, capable
    # of serving all Tables in the parent
    # Instance.
  "defaultStorageType": "A String", # (`CreationOnly`)
      # The type of storage used by this cluster to serve its
      # parent instance's tables, unless explicitly overridden.
  "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
      # throughput and more consistent performance.
  "state": "A String", # (`OutputOnly`)
      # The current state of the cluster.
  "location": "A String", # (`CreationOnly`)
      # The location where this cluster's nodes and storage reside. For best
      # performance, clients should be located as close as possible to this
      # cluster. Currently only zones are supported, so values should be of the
      # form `projects/{project}/locations/{zone}`.
  "name": "A String", # Required. (`OutputOnly`)
      # The unique name of the cluster. Values are of the form
      # `projects/{project}/instances/{instance}/clusters/a-z*`.
}

  clusterId: string, Required. The ID to be used when referring to the new cluster within its instance,
e.g., just `mycluster` rather than
`projects/myproject/instances/myinstance/clusters/mycluster`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
delete(name, x__xgafv=None)
Deletes a cluster from an instance.

Args:
  name: string, Required. The unique name of the cluster to be deleted. Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None)
Gets information about a cluster.

Args:
  name: string, Required. The unique name of the requested cluster. Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resizable group of nodes in a particular cloud location, capable
      # of serving all Tables in the parent
      # Instance.
    "defaultStorageType": "A String", # (`CreationOnly`)
        # The type of storage used by this cluster to serve its
        # parent instance's tables, unless explicitly overridden.
    "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
        # throughput and more consistent performance.
    "state": "A String", # (`OutputOnly`)
        # The current state of the cluster.
    "location": "A String", # (`CreationOnly`)
        # The location where this cluster's nodes and storage reside. For best
        # performance, clients should be located as close as possible to this
        # cluster. Currently only zones are supported, so values should be of the
        # form `projects/{project}/locations/{zone}`.
    "name": "A String", # Required. (`OutputOnly`)
        # The unique name of the cluster. Values are of the form
        # `projects/{project}/instances/{instance}/clusters/a-z*`.
  }
list(parent, pageToken=None, x__xgafv=None)
Lists information about clusters in an instance.

Args:
  parent: string, Required. The unique name of the instance for which a list of clusters is requested.
Values are of the form `projects/{project}/instances/{instance}`.
Use `{instance} = '-'` to list Clusters for all Instances in a project,
e.g., `projects/myproject/instances/-`. (required)
  pageToken: string, DEPRECATED: This field is unused and ignored.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for BigtableInstanceAdmin.ListClusters.
    "nextPageToken": "A String", # DEPRECATED: This field is unused and ignored.
    "clusters": [ # The list of requested clusters.
      { # A resizable group of nodes in a particular cloud location, capable
          # of serving all Tables in the parent
          # Instance.
        "defaultStorageType": "A String", # (`CreationOnly`)
            # The type of storage used by this cluster to serve its
            # parent instance's tables, unless explicitly overridden.
        "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
            # throughput and more consistent performance.
        "state": "A String", # (`OutputOnly`)
            # The current state of the cluster.
        "location": "A String", # (`CreationOnly`)
            # The location where this cluster's nodes and storage reside. For best
            # performance, clients should be located as close as possible to this
            # cluster. Currently only zones are supported, so values should be of the
            # form `projects/{project}/locations/{zone}`.
        "name": "A String", # Required. (`OutputOnly`)
            # The unique name of the cluster. Values are of the form
            # `projects/{project}/instances/{instance}/clusters/a-z*`.
      },
    ],
    "failedLocations": [ # Locations from which Cluster information could not be retrieved,
        # due to an outage or some other transient condition.
        # Clusters from these locations may be missing from `clusters`,
        # or may only have partial information returned.
        # Values are of the form `projects/<project>/locations/<zone_id>`
      "A String",
    ],
  }
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.
    
update(name, body=None, x__xgafv=None)
Updates a cluster within an instance.

Args:
  name: string, Required. (`OutputOnly`)
The unique name of the cluster. Values are of the form
`projects/{project}/instances/{instance}/clusters/a-z*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A resizable group of nodes in a particular cloud location, capable
    # of serving all Tables in the parent
    # Instance.
  "defaultStorageType": "A String", # (`CreationOnly`)
      # The type of storage used by this cluster to serve its
      # parent instance's tables, unless explicitly overridden.
  "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
      # throughput and more consistent performance.
  "state": "A String", # (`OutputOnly`)
      # The current state of the cluster.
  "location": "A String", # (`CreationOnly`)
      # The location where this cluster's nodes and storage reside. For best
      # performance, clients should be located as close as possible to this
      # cluster. Currently only zones are supported, so values should be of the
      # form `projects/{project}/locations/{zone}`.
  "name": "A String", # Required. (`OutputOnly`)
      # The unique name of the cluster. Values are of the form
      # `projects/{project}/instances/{instance}/clusters/a-z*`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }