Google Cloud Network Connectivity V1 Client - Class MulticloudDataTransferConfig (2.4.0)

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

The MulticloudDataTransferConfig resource. It lists the services that you configure for Data Transfer Essentials billing and metering.

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

Namespace

Google \ Cloud \ NetworkConnectivity \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The name of the MulticloudDataTransferConfig resource. Format: projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}.

↳ create_time Google\Protobuf\Timestamp

Output only. Time when the MulticloudDataTransferConfig resource was created.

↳ update_time Google\Protobuf\Timestamp

Output only. Time when the MulticloudDataTransferConfig resource was updated.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. User-defined labels.

↳ etag string

The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.

↳ description string

Optional. A description of this resource.

↳ destinations_count int

Output only. The number of Destination resources configured for the MulticloudDataTransferConfig resource.

↳ destinations_active_count int

Output only. The number of Destination resources in use with the MulticloudDataTransferConfig resource.

↳ services array|Google\Protobuf\Internal\MapField

Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either ADDING or DELETING, depending on the actions taken. Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }

↳ uid string

Output only. The Google-generated unique ID for the MulticloudDataTransferConfig resource. This value is unique across all MulticloudDataTransferConfig resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.

getName

Identifier. The name of the MulticloudDataTransferConfig resource.

Format: projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}.

Returns
Type Description
string

setName

Identifier. The name of the MulticloudDataTransferConfig resource.

Format: projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Time when the MulticloudDataTransferConfig resource was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time when the MulticloudDataTransferConfig resource was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Time when the MulticloudDataTransferConfig resource was updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time when the MulticloudDataTransferConfig resource was updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

Optional. User-defined labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. User-defined labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getEtag

The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.

Returns
Type Description
string

setEtag

The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. A description of this resource.

Returns
Type Description
string

setDescription

Optional. A description of this resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getDestinationsCount

Output only. The number of Destination resources configured for the MulticloudDataTransferConfig resource.

Returns
Type Description
int

setDestinationsCount

Output only. The number of Destination resources configured for the MulticloudDataTransferConfig resource.

Parameter
Name Description
var int
Returns
Type Description
$this

getDestinationsActiveCount

Output only. The number of Destination resources in use with the MulticloudDataTransferConfig resource.

Returns
Type Description
int

setDestinationsActiveCount

Output only. The number of Destination resources in use with the MulticloudDataTransferConfig resource.

Parameter
Name Description
var int
Returns
Type Description
$this

getServices

Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either ADDING or DELETING, depending on the actions taken.

Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }

Returns
Type Description
Google\Protobuf\Internal\MapField

setServices

Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either ADDING or DELETING, depending on the actions taken.

Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getUid

Output only. The Google-generated unique ID for the MulticloudDataTransferConfig resource. This value is unique across all MulticloudDataTransferConfig resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.

Returns
Type Description
string

setUid

Output only. The Google-generated unique ID for the MulticloudDataTransferConfig resource. This value is unique across all MulticloudDataTransferConfig resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.

Parameter
Name Description
var string
Returns
Type Description
$this