Google Cloud Config V1 Client - Class CreatePreviewRequest (1.0.0)

Reference documentation and code samples for the Google Cloud Config V1 Client class CreatePreviewRequest.

A request to create a preview.

Generated from protobuf message google.cloud.config.v1.CreatePreviewRequest

Namespace

Google \ Cloud \ Config \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

↳ preview_id string

Optional. The preview ID.

↳ preview Google\Cloud\Config\V1\Preview

Required. Preview resource to be created.

↳ 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 in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

Returns
Type Description
string

setParent

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

Parameter
Name Description
var string
Returns
Type Description
$this

getPreviewId

Optional. The preview ID.

Returns
Type Description
string

setPreviewId

Optional. The preview ID.

Parameter
Name Description
var string
Returns
Type Description
$this

getPreview

Required. Preview resource to be created.

Returns
Type Description
Google\Cloud\Config\V1\Preview|null

hasPreview

clearPreview

setPreview

Required. Preview resource to be created.

Parameter
Name Description
var Google\Cloud\Config\V1\Preview
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 in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'. Please see Google\Cloud\Config\V1\ConfigClient::locationName() for help formatting this field.

preview Google\Cloud\Config\V1\Preview

Required. Preview resource to be created.

Returns
Type Description
Google\Cloud\Config\V1\CreatePreviewRequest