Google Cloud Datastream V1 Client - Class CreateConnectionProfileRequest (1.4.2)

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

Request message for creating a connection profile.

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

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent that owns the collection of ConnectionProfiles.

↳ connection_profile_id string

Required. The connection profile identifier.

↳ connection_profile Google\Cloud\Datastream\V1\ConnectionProfile

Required. The connection profile 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).

↳ validate_only bool

Optional. Only validate the connection profile, but don't create any resources. The default is false.

↳ force bool

Optional. Create the connection profile without validating it.

getParent

Required. The parent that owns the collection of ConnectionProfiles.

Returns
TypeDescription
string

setParent

Required. The parent that owns the collection of ConnectionProfiles.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getConnectionProfileId

Required. The connection profile identifier.

Returns
TypeDescription
string

setConnectionProfileId

Required. The connection profile identifier.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getConnectionProfile

Required. The connection profile resource to create.

Returns
TypeDescription
Google\Cloud\Datastream\V1\ConnectionProfile|null

hasConnectionProfile

clearConnectionProfile

setConnectionProfile

Required. The connection profile resource to create.

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

getValidateOnly

Optional. Only validate the connection profile, but don't create any resources. The default is false.

Returns
TypeDescription
bool

setValidateOnly

Optional. Only validate the connection profile, but don't create any resources. The default is false.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getForce

Optional. Create the connection profile without validating it.

Returns
TypeDescription
bool

setForce

Optional. Create the connection profile without validating it.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. The parent that owns the collection of ConnectionProfiles. Please see Google\Cloud\Datastream\V1\DatastreamClient::locationName() for help formatting this field.

connectionProfile Google\Cloud\Datastream\V1\ConnectionProfile

Required. The connection profile resource to create.

connectionProfileId string

Required. The connection profile identifier.

Returns
TypeDescription
Google\Cloud\Datastream\V1\CreateConnectionProfileRequest