Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class Destination.
The Destination resource. It specifies the IP prefix and the associated
autonomous system numbers (ASN) that you want to include in a
MulticloudDataTransferConfig resource.
Generated from protobuf message google.cloud.networkconnectivity.v1.Destination
Namespace
Google \ Cloud \ NetworkConnectivity \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The name of the |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time when the |
↳ 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. |
↳ ip_prefix |
string
Required. Immutable. The IP prefix that represents your workload on another CSP. |
↳ endpoints |
array<Destination\DestinationEndpoint>
Required. Unordered list. The list of |
↳ state_timeline |
StateTimeline
Output only. The timeline of the expected |
↳ uid |
string
Output only. The Google-generated unique ID for the |
getName
Identifier. The name of the Destination resource.
Format:
projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The name of the Destination resource.
Format:
projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Time when the Destination resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the Destination resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Time when the Destination resource was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the Destination 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 |
|
getIpPrefix
Required. Immutable. The IP prefix that represents your workload on another CSP.
| Returns | |
|---|---|
| Type | Description |
string |
|
setIpPrefix
Required. Immutable. The IP prefix that represents your workload on another CSP.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndpoints
Required. Unordered list. The list of DestinationEndpoint resources
configured for the IP prefix.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEndpoints
Required. Unordered list. The list of DestinationEndpoint resources
configured for the IP prefix.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Destination\DestinationEndpoint>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStateTimeline
Output only. The timeline of the expected Destination states or the
current rest state. If a state change is expected, the value is ADDING,
DELETING or SUSPENDING, depending on the action specified.
Example:
"state_timeline": {
"states": [
{
// The time when the Destination resource will be activated.
"effectiveTime": "2024-12-01T08:00:00Z",
"state": "ADDING"
},
{
// The time when the Destination resource will be suspended.
"effectiveTime": "2024-12-01T20:00:00Z",
"state": "SUSPENDING"
}
]
}
| Returns | |
|---|---|
| Type | Description |
StateTimeline|null |
|
hasStateTimeline
clearStateTimeline
setStateTimeline
Output only. The timeline of the expected Destination states or the
current rest state. If a state change is expected, the value is ADDING,
DELETING or SUSPENDING, depending on the action specified.
Example:
"state_timeline": {
"states": [
{
// The time when the Destination resource will be activated.
"effectiveTime": "2024-12-01T08:00:00Z",
"state": "ADDING"
},
{
// The time when the Destination resource will be suspended.
"effectiveTime": "2024-12-01T20:00:00Z",
"state": "SUSPENDING"
}
]
}
| Parameter | |
|---|---|
| Name | Description |
var |
StateTimeline
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. The Google-generated unique ID for the Destination resource.
This value is unique across all Destination 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 Destination resource.
This value is unique across all Destination 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 |
|