Network Connectivity v1 API - Class MulticloudDataTransferConfigName (2.12.0) 

public sealed class MulticloudDataTransferConfigName : IResourceName, IEquatable<MulticloudDataTransferConfigName>

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

Resource name for the MulticloudDataTransferConfig resource.

Inheritance

object > MulticloudDataTransferConfigName

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

MulticloudDataTransferConfigName(string, string, string)

public MulticloudDataTransferConfigName(string projectId, string locationId, string multicloudDataTransferConfigId)

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

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.

Properties

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 MulticloudDataTransferConfigName.ResourceNameType Type { get; }

The MulticloudDataTransferConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
MulticloudDataTransferConfigNameResourceNameType

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)

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

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

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.
Returns
Type Description
string

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

FormatProjectLocationMulticloudDataTransferConfig(string, string, string)

public static string FormatProjectLocationMulticloudDataTransferConfig(string projectId, string locationId, string multicloudDataTransferConfigId)

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

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.
Returns
Type Description
string

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

FromProjectLocationMulticloudDataTransferConfig(string, string, string)

public static MulticloudDataTransferConfigName FromProjectLocationMulticloudDataTransferConfig(string projectId, string locationId, string multicloudDataTransferConfigId)

Creates a MulticloudDataTransferConfigName with the pattern projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config} .

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.
Returns
Type Description
MulticloudDataTransferConfigName

A new instance of MulticloudDataTransferConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MulticloudDataTransferConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MulticloudDataTransferConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of MulticloudDataTransferConfigName 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 MulticloudDataTransferConfigName Parse(string multicloudDataTransferConfigName)

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

Parameter
Name Description
multicloudDataTransferConfigName string

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

The parsed MulticloudDataTransferConfigName 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}

Parse(string, bool)

public static MulticloudDataTransferConfigName Parse(string multicloudDataTransferConfigName, bool allowUnparsed)

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

Parameters
Name Description
multicloudDataTransferConfigName 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
MulticloudDataTransferConfigName

The parsed MulticloudDataTransferConfigName 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}
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 MulticloudDataTransferConfigName)

public static bool TryParse(string multicloudDataTransferConfigName, out MulticloudDataTransferConfigName result)

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

Parameters
Name Description
multicloudDataTransferConfigName string

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

When this method returns, the parsed MulticloudDataTransferConfigName, 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}

TryParse(string, bool, out MulticloudDataTransferConfigName)

public static bool TryParse(string multicloudDataTransferConfigName, bool allowUnparsed, out MulticloudDataTransferConfigName result)

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

Parameters
Name Description
multicloudDataTransferConfigName 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 MulticloudDataTransferConfigName

When this method returns, the parsed MulticloudDataTransferConfigName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(MulticloudDataTransferConfigName, MulticloudDataTransferConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MulticloudDataTransferConfigName

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

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 !=(MulticloudDataTransferConfigName, MulticloudDataTransferConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MulticloudDataTransferConfigName

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

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.