Google Cloud BeyondCorp AppGateways V1 Client - Class CreateAppGatewayRequest (0.3.2)

Reference documentation and code samples for the Google Cloud BeyondCorp AppGateways V1 Client class CreateAppGatewayRequest.

Request message for BeyondCorp.CreateAppGateway.

Generated from protobuf message google.cloud.beyondcorp.appgateways.v1.CreateAppGatewayRequest

Namespace

Google \ Cloud \ BeyondCorp \ AppGateways \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource project name of the AppGateway location using the form: projects/{project_id}/locations/{location_id}

↳ app_gateway_id string

Optional. User-settable AppGateway 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.

↳ app_gateway Google\Cloud\BeyondCorp\AppGateways\V1\AppGateway

Required. A BeyondCorp AppGateway resource.

↳ 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. The resource project name of the AppGateway location using the form: projects/{project_id}/locations/{location_id}

Returns
TypeDescription
string

setParent

Required. The resource project name of the AppGateway location using the form: projects/{project_id}/locations/{location_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAppGatewayId

Optional. User-settable AppGateway 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
TypeDescription
string

setAppGatewayId

Optional. User-settable AppGateway 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
NameDescription
var string
Returns
TypeDescription
$this

getAppGateway

Required. A BeyondCorp AppGateway resource.

Returns
TypeDescription
Google\Cloud\BeyondCorp\AppGateways\V1\AppGateway|null

hasAppGateway

clearAppGateway

setAppGateway

Required. A BeyondCorp AppGateway resource.

Parameter
NameDescription
var Google\Cloud\BeyondCorp\AppGateways\V1\AppGateway
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getValidateOnly

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

Returns
TypeDescription
bool

setValidateOnly

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. The resource project name of the AppGateway location using the form: projects/{project_id}/locations/{location_id} Please see Google\Cloud\BeyondCorp\AppGateways\V1\AppGatewaysServiceClient::locationName() for help formatting this field.

appGateway Google\Cloud\BeyondCorp\AppGateways\V1\AppGateway

Required. A BeyondCorp AppGateway resource.

appGatewayId string

Optional. User-settable AppGateway 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
TypeDescription
Google\Cloud\BeyondCorp\AppGateways\V1\CreateAppGatewayRequest