Google Cloud Datastream V1 Client - Class CreatePrivateConnectionRequest (2.1.0)

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

Request for creating a private connection.

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

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 PrivateConnections.

↳ private_connection_id string

Required. The private connectivity identifier.

↳ private_connection PrivateConnection

Required. The Private Connectivity 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).

↳ force bool

Optional. If set to true, will skip validations.

getParent

Required. The parent that owns the collection of PrivateConnections.

Returns
Type Description
string

setParent

Required. The parent that owns the collection of PrivateConnections.

Parameter
Name Description
var string
Returns
Type Description
$this

getPrivateConnectionId

Required. The private connectivity identifier.

Returns
Type Description
string

setPrivateConnectionId

Required. The private connectivity identifier.

Parameter
Name Description
var string
Returns
Type Description
$this

getPrivateConnection

Required. The Private Connectivity resource to create.

Returns
Type Description
PrivateConnection|null

hasPrivateConnection

clearPrivateConnection

setPrivateConnection

Required. The Private Connectivity resource to create.

Parameter
Name Description
var PrivateConnection
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

getForce

Optional. If set to true, will skip validations.

Returns
Type Description
bool

setForce

Optional. If set to true, will skip validations.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent that owns the collection of PrivateConnections. Please see DatastreamClient::locationName() for help formatting this field.

privateConnection PrivateConnection

Required. The Private Connectivity resource to create.

privateConnectionId string

Required. The private connectivity identifier.

Returns
Type Description
CreatePrivateConnectionRequest