Network Connectivity v1 API - Class DestinationName (2.12.0) 

public sealed class DestinationName : IResourceName, IEquatable<DestinationName>

Reference documentation and code samples for the Network Connectivity v1 API class DestinationName.

Resource name for the Destination resource.

Inheritance

object > DestinationName

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

DestinationName(string, string, string, string)

public DestinationName(string projectId, string locationId, string multicloudDataTransferConfigId, string destinationId)

Constructs a new instance of a DestinationName class from the component parts of pattern projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
multicloudDataTransferConfigId string

The MulticloudDataTransferConfig ID. Must not be null or empty.
destinationId string

The Destination ID. Must not be null or empty.

Properties

DestinationId

public string DestinationId { get; }

The Destination ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

MulticloudDataTransferConfigId

public string MulticloudDataTransferConfigId { get; }

The MulticloudDataTransferConfig ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public DestinationName.ResourceNameType Type { get; }

The DestinationName.ResourceNameType of the contained resource name.

Property Value
Type Description
DestinationNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string multicloudDataTransferConfigId, string destinationId)

Formats the IDs into the string representation of this DestinationName with pattern projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
multicloudDataTransferConfigId string

The MulticloudDataTransferConfig ID. Must not be null or empty.
destinationId string

The Destination ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DestinationName with pattern projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination} .

FormatProjectLocationMulticloudDataTransferConfigDestination(string, string, string, string)

public static string FormatProjectLocationMulticloudDataTransferConfigDestination(string projectId, string locationId, string multicloudDataTransferConfigId, string destinationId)

Formats the IDs into the string representation of this DestinationName with pattern projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
multicloudDataTransferConfigId string

The MulticloudDataTransferConfig ID. Must not be null or empty.
destinationId string

The Destination ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DestinationName with pattern projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination} .

FromProjectLocationMulticloudDataTransferConfigDestination(string, string, string, string)

public static DestinationName FromProjectLocationMulticloudDataTransferConfigDestination(string projectId, string locationId, string multicloudDataTransferConfigId, string destinationId)

Creates a DestinationName with the pattern projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
multicloudDataTransferConfigId string

The MulticloudDataTransferConfig ID. Must not be null or empty.
destinationId string

The Destination ID. Must not be null or empty.
Returns
Type Description
DestinationName

A new instance of DestinationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DestinationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DestinationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DestinationName

A new instance of DestinationName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static DestinationName Parse(string destinationName)

Parses the given resource name string into a new DestinationName instance.

Parameter
Name Description
destinationName string

The resource name in string form. Must not be null.
Returns
Type Description
DestinationName

The parsed DestinationName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}

Parse(string, bool)

public static DestinationName Parse(string destinationName, bool allowUnparsed)

Parses the given resource name string into a new DestinationName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
destinationName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
Returns
Type Description
DestinationName

The parsed DestinationName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out DestinationName)

public static bool TryParse(string destinationName, out DestinationName result)

Tries to parse the given resource name string into a new DestinationName instance.

Parameters
Name Description
destinationName string

The resource name in string form. Must not be null.
result DestinationName

When this method returns, the parsed DestinationName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}

TryParse(string, bool, out DestinationName)

public static bool TryParse(string destinationName, bool allowUnparsed, out DestinationName result)

Tries to parse the given resource name string into a new DestinationName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
destinationName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
result DestinationName

When this method returns, the parsed DestinationName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DestinationName, DestinationName)

public static bool operator ==(DestinationName a, DestinationName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DestinationName

The first resource name to compare, or null.
b DestinationName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(DestinationName, DestinationName)

public static bool operator !=(DestinationName a, DestinationName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a DestinationName

The first resource name to compare, or null.
b DestinationName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.