1. class
  2. Google
  3. \
  4. Service
  5. \
  6. BigtableAdmin
  7. \
  8. Resource
  9. \
  10. ProjectsInstances

ProjectsInstances

class ProjectsInstances extends Resource (View source)

The "instances" collection of methods.

Typical usage is:

 $bigtableadminService = new Google\Service\BigtableAdmin(...);
 $instances = $bigtableadminService->projects_instances;

Methods

Operation
create(string $parent, CreateInstanceRequest $postBody, array $optParams = [])

Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled. (instances.create)

BigtableadminEmpty
delete(string $name, array $optParams = [])

Delete an instance from a project. (instances.delete)

Instance
get(string $name, array $optParams = [])

Gets information about an instance. (instances.get)

Policy
getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

ListInstancesResponse
listProjectsInstances(string $parent, array $optParams = [])

Lists information about instances in a project.

Operation
partialUpdateInstance(string $name, Instance $postBody, array $optParams = [])

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on an instance resource. Replaces any existing policy. (instances.setIamPolicy)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that the caller has on the specified instance resource.

Instance
update(string $name, Instance $postBody, array $optParams = [])

Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance. (instances.update)

Details

at line 55
Operation create(string $parent, CreateInstanceRequest $postBody, array $optParams = [])

Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled. (instances.create)

Parameters

string $parent

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.
CreateInstanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 70
BigtableadminEmpty delete(string $name, array $optParams = [])

Delete an instance from a project. (instances.delete)

Parameters

string $name

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.
array $optParams

Optional parameters.

Return Value

BigtableadminEmpty

Exceptions

Exception

at line 85
Instance get(string $name, array $optParams = [])

Gets information about an instance. (instances.get)

Parameters

string $name

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.
array $optParams

Optional parameters.

Return Value

Instance

Exceptions

Exception

at line 105
Policy getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

(instances.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
GetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 123
ListInstancesResponse listProjectsInstances(string $parent, array $optParams = [])

Lists information about instances in a project.

(instances.listProjectsInstances)

Parameters

string $parent

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.
array $optParams

Optional parameters.

Return Value

ListInstancesResponse

Exceptions

Exception

at line 144
Operation partialUpdateInstance(string $name, Instance $postBody, array $optParams = [])

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

(instances.partialUpdateInstance)

Parameters

string $name

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].
Instance $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 163
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on an instance resource. Replaces any existing policy. (instances.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 182
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that the caller has on the specified instance resource.

(instances.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception

at line 200
Instance update(string $name, Instance $postBody, array $optParams = [])

Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance. (instances.update)

Parameters

string $name

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].
Instance $postBody
array $optParams

Optional parameters.

Return Value

Instance

Exceptions

Exception