Reference documentation and code samples for the Google Cloud Memorystore V1 Client class CreateInstanceRequest.
Request message for CreateInstance.
Generated from protobuf message google.cloud.memorystore.v1.CreateInstanceRequest
Namespace
Google \ Cloud \ Memorystore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource where this instance will be created. Format: projects/{project}/locations/{location} |
↳ instance_id |
string
Required. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions: * * Must be 4-63 characters in length * * Must begin with a letter or digit * * Must contain only lowercase letters, digits, and hyphens * * Must not end with a hyphen * * Must be unique within a location |
↳ instance |
Instance
Required. The instance to create. |
↳ request_id |
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
getParent
Required. The parent resource where this instance will be created.
Format: projects/{project}/locations/{location}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent resource where this instance will be created.
Format: projects/{project}/locations/{location}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstanceId
Required. The ID to use for the instance, which will become the final component of the instance's resource name.
This value is subject to the following restrictions:
- Must be 4-63 characters in length
- Must begin with a letter or digit
- Must contain only lowercase letters, digits, and hyphens
- Must not end with a hyphen
- Must be unique within a location
| Returns | |
|---|---|
| Type | Description |
string |
|
setInstanceId
Required. The ID to use for the instance, which will become the final component of the instance's resource name.
This value is subject to the following restrictions:
- Must be 4-63 characters in length
- Must begin with a letter or digit
- Must contain only lowercase letters, digits, and hyphens
- Must not end with a hyphen
- Must be unique within a location
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstance
Required. The instance to create.
| Returns | |
|---|---|
| Type | Description |
Instance|null |
|
hasInstance
clearInstance
setInstance
Required. The instance to create.
| Parameter | |
|---|---|
| Name | Description |
var |
Instance
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Returns | |
|---|---|
| Type | Description |
string |
|
setRequestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource where this instance will be created. Format: projects/{project}/locations/{location} Please see MemorystoreClient::locationName() for help formatting this field. |
instance |
Instance
Required. The instance to create. |
instanceId |
string
Required. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions:
|
| Returns | |
|---|---|
| Type | Description |
CreateInstanceRequest |
|