Google Cloud Network Connectivity V1 Client - Class CreatePolicyBasedRouteRequest (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class CreatePolicyBasedRouteRequest.

Request for PolicyBasedRouting.CreatePolicyBasedRoute method.

Generated from protobuf message google.cloud.networkconnectivity.v1.CreatePolicyBasedRouteRequest

Namespace

Google \ Cloud \ NetworkConnectivity \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource's name of the PolicyBasedRoute.

↳ policy_based_route_id string

Required. Unique id for the Policy Based Route to create.

↳ policy_based_route Google\Cloud\NetworkConnectivity\V1\PolicyBasedRoute

Required. Initial values for a new Policy Based Route.

↳ 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's name of the PolicyBasedRoute.

Returns
Type Description
string

setParent

Required. The parent resource's name of the PolicyBasedRoute.

Parameter
Name Description
var string
Returns
Type Description
$this

getPolicyBasedRouteId

Required. Unique id for the Policy Based Route to create.

Returns
Type Description
string

setPolicyBasedRouteId

Required. Unique id for the Policy Based Route to create.

Parameter
Name Description
var string
Returns
Type Description
$this

getPolicyBasedRoute

Required. Initial values for a new Policy Based Route.

Returns
Type Description
Google\Cloud\NetworkConnectivity\V1\PolicyBasedRoute|null

hasPolicyBasedRoute

clearPolicyBasedRoute

setPolicyBasedRoute

Required. Initial values for a new Policy Based Route.

Parameter
Name Description
var Google\Cloud\NetworkConnectivity\V1\PolicyBasedRoute
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's name of the PolicyBasedRoute. Please see Google\Cloud\NetworkConnectivity\V1\PolicyBasedRoutingServiceClient::locationName() for help formatting this field.

policyBasedRoute Google\Cloud\NetworkConnectivity\V1\PolicyBasedRoute

Required. Initial values for a new Policy Based Route.

policyBasedRouteId string

Required. Unique id for the Policy Based Route to create.

Returns
Type Description
Google\Cloud\NetworkConnectivity\V1\CreatePolicyBasedRouteRequest