Google Cloud BeyondCorp Client Gateways V1 Client - Class CreateClientGatewayRequest (0.5.0)

Reference documentation and code samples for the Google Cloud BeyondCorp Client Gateways V1 Client class CreateClientGatewayRequest.

Message for creating a ClientGateway.

Generated from protobuf message google.cloud.beyondcorp.clientgateways.v1.CreateClientGatewayRequest

Namespace

Google \ Cloud \ BeyondCorp \ ClientGateways \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Value for parent.

↳ client_gateway_id string

Optional. User-settable client gateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from /[a-z][0-9]-/. * Must end with a number or a letter.

↳ client_gateway Google\Cloud\BeyondCorp\ClientGateways\V1\ClientGateway

Required. The resource being 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 t he 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).

↳ validate_only bool

Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

getParent

Required. Value for parent.

Returns
Type Description
string

setParent

Required. Value for parent.

Parameter
Name Description
var string
Returns
Type Description
$this

getClientGatewayId

Optional. User-settable client gateway resource ID.

  • Must start with a letter.
    • Must contain between 4-63 characters from /[a-z][0-9]-/.
    • Must end with a number or a letter.
Returns
Type Description
string

setClientGatewayId

Optional. User-settable client gateway resource ID.

  • Must start with a letter.
    • Must contain between 4-63 characters from /[a-z][0-9]-/.
    • Must end with a number or a letter.
Parameter
Name Description
var string
Returns
Type Description
$this

getClientGateway

Required. The resource being created.

Returns
Type Description
Google\Cloud\BeyondCorp\ClientGateways\V1\ClientGateway|null

hasClientGateway

clearClientGateway

setClientGateway

Required. The resource being created.

Parameter
Name Description
var Google\Cloud\BeyondCorp\ClientGateways\V1\ClientGateway
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 t he 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 t he 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

getValidateOnly

Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

Returns
Type Description
bool

setValidateOnly

Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. Value for parent. Please see Google\Cloud\BeyondCorp\ClientGateways\V1\ClientGatewaysServiceClient::locationName() for help formatting this field.

clientGateway Google\Cloud\BeyondCorp\ClientGateways\V1\ClientGateway

Required. The resource being created.

clientGatewayId string

Optional. User-settable client gateway resource ID.

  • Must start with a letter.
  • Must contain between 4-63 characters from /[a-z][0-9]-/.
  • Must end with a number or a letter.
Returns
Type Description
Google\Cloud\BeyondCorp\ClientGateways\V1\CreateClientGatewayRequest