Google Cloud Datastream V1 Client - Class CreateRouteRequest (1.5.4)

Reference documentation and code samples for the Google Cloud Datastream V1 Client class CreateRouteRequest.

Route creation request.

Generated from protobuf message google.cloud.datastream.v1.CreateRouteRequest

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent that owns the collection of Routes.

↳ route_id string

Required. The Route identifier.

↳ route Google\Cloud\Datastream\V1\Route

Required. The Route resource to create.

↳ request_id string

Optional. A 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 that owns the collection of Routes.

Returns
Type Description
string

setParent

Required. The parent that owns the collection of Routes.

Parameter
Name Description
var string
Returns
Type Description
$this

getRouteId

Required. The Route identifier.

Returns
Type Description
string

setRouteId

Required. The Route identifier.

Parameter
Name Description
var string
Returns
Type Description
$this

getRoute

Required. The Route resource to create.

Returns
Type Description
Google\Cloud\Datastream\V1\Route|null

hasRoute

clearRoute

setRoute

Required. The Route resource to create.

Parameter
Name Description
var Google\Cloud\Datastream\V1\Route
Returns
Type Description
$this

getRequestId

Optional. A 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. A 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 that owns the collection of Routes. Please see Google\Cloud\Datastream\V1\DatastreamClient::privateConnectionName() for help formatting this field.

route Google\Cloud\Datastream\V1\Route

Required. The Route resource to create.

routeId string

Required. The Route identifier.

Returns
Type Description
Google\Cloud\Datastream\V1\CreateRouteRequest