Cloud Spanner V1 Client - Class GetInstanceRequest (1.54.2)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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>.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setName

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFieldMask

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

Generated from protobuf field .google.protobuf.FieldMask field_mask = 2;

Returns
TypeDescription
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.

Generated from protobuf field .google.protobuf.FieldMask field_mask = 2;

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this