Cloud Spanner V1 Client - Class GetInstanceRequest (1.76.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class GetInstanceRequest.

The request for GetInstance.

Generated from protobuf message google.spanner.admin.instance.v1.GetInstanceRequest

Namespace

Google \ Cloud \ Spanner \ Admin \ Instance \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the requested instance. Values are of the form projects/<project>/instances/<instance>.
↳ field_mask Google\Protobuf\FieldMask

If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned.

getName

Required. The name of the requested instance. Values are of the form projects/<project>/instances/<instance>.

Returns
Type Description
string

setName

Required. The name of the requested instance. Values are of the form projects/<project>/instances/<instance>.

Parameter
Name Description
var string
Returns
Type Description
$this

getFieldMask

If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasFieldMask

clearFieldMask

setFieldMask

If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the requested instance. Values are of the form projects/<project>/instances/<instance>. Please see Google\Cloud\Spanner\Admin\Instance\V1\InstanceAdminClient::instanceName() for help formatting this field.
Returns
Type Description
Google\Cloud\Spanner\Admin\Instance\V1\GetInstanceRequest