Memorystore for Memcached V1 Client - Class CreateInstanceRequest (2.0.2)

Reference documentation and code samples for the Memorystore for Memcached V1 Client class CreateInstanceRequest.

Request for CreateInstance.

Generated from protobuf message google.cloud.memcache.v1.CreateInstanceRequest

Namespace

Google \ Cloud \ Memcache \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region
↳ instance_id string

Required. The logical name of the Memcached instance in the user project with the following restrictions: * * Must contain only lowercase letters, numbers, and hyphens. * * Must start with a letter. * * Must be between 1-40 characters. * * Must end with a number or a letter. * * Must be unique within the user project / location. If any of the above are not met, the API raises an invalid argument error.
↳ instance Instance

Required. A Memcached Instance

getParent

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region

Returns
Type Description
string

setParent

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region

Parameter
Name Description
var string
Returns
Type Description
$this

getInstanceId

Required. The logical name of the Memcached instance in the user project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.

  • Must start with a letter.

  • Must be between 1-40 characters.
  • Must end with a number or a letter.
  • Must be unique within the user project / location. If any of the above are not met, the API raises an invalid argument error.
Returns
Type Description
string

setInstanceId

Required. The logical name of the Memcached instance in the user project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.

  • Must start with a letter.

  • Must be between 1-40 characters.
  • Must end with a number or a letter.
  • Must be unique within the user project / location. If any of the above are not met, the API raises an invalid argument error.
Parameter
Name Description
var string
Returns
Type Description
$this

getInstance

Required. A Memcached Instance

Returns
Type Description
Instance|null

hasInstance

clearInstance

setInstance

Required. A Memcached Instance

Parameter
Name Description
var Instance
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region Please see CloudMemcacheClient::locationName() for help formatting this field.
instance Instance

Required. A Memcached Instance
instanceId string

Required. The logical name of the Memcached instance in the user project with the following restrictions:

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-40 characters.
    • Must end with a number or a letter.
    • Must be unique within the user project / location.

If any of the above are not met, the API raises an invalid argument error.
Returns
Type Description
CreateInstanceRequest