VM Migration v1 API - Class DatacenterConnectorName (2.5.0)

public sealed class DatacenterConnectorName : IResourceName, IEquatable<DatacenterConnectorName>

Reference documentation and code samples for the VM Migration v1 API class DatacenterConnectorName.

Resource name for the DatacenterConnector resource.

Inheritance

object > DatacenterConnectorName

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

DatacenterConnectorName(string, string, string, string)

public DatacenterConnectorName(string projectId, string locationId, string sourceId, string datacenterConnectorId)

Constructs a new instance of a DatacenterConnectorName class from the component parts of pattern projects/{project}/locations/{location}/sources/{source}/datacenterConnectors/{datacenter_connector}

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.

sourceId string

The Source ID. Must not be null or empty.

datacenterConnectorId string

The DatacenterConnector ID. Must not be null or empty.

Properties

DatacenterConnectorId

public string DatacenterConnectorId { get; }

The DatacenterConnector 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

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

SourceId

public string SourceId { get; }

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

Property Value
Type Description
string

Type

public DatacenterConnectorName.ResourceNameType Type { get; }

The DatacenterConnectorName.ResourceNameType of the contained resource name.

Property Value
Type Description
DatacenterConnectorNameResourceNameType

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 sourceId, string datacenterConnectorId)

Formats the IDs into the string representation of this DatacenterConnectorName with pattern projects/{project}/locations/{location}/sources/{source}/datacenterConnectors/{datacenter_connector}.

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.

sourceId string

The Source ID. Must not be null or empty.

datacenterConnectorId string

The DatacenterConnector ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DatacenterConnectorName with pattern projects/{project}/locations/{location}/sources/{source}/datacenterConnectors/{datacenter_connector}.

FormatProjectLocationSourceDatacenterConnector(string, string, string, string)

public static string FormatProjectLocationSourceDatacenterConnector(string projectId, string locationId, string sourceId, string datacenterConnectorId)

Formats the IDs into the string representation of this DatacenterConnectorName with pattern projects/{project}/locations/{location}/sources/{source}/datacenterConnectors/{datacenter_connector}.

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.

sourceId string

The Source ID. Must not be null or empty.

datacenterConnectorId string

The DatacenterConnector ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DatacenterConnectorName with pattern projects/{project}/locations/{location}/sources/{source}/datacenterConnectors/{datacenter_connector}.

FromProjectLocationSourceDatacenterConnector(string, string, string, string)

public static DatacenterConnectorName FromProjectLocationSourceDatacenterConnector(string projectId, string locationId, string sourceId, string datacenterConnectorId)

Creates a DatacenterConnectorName with the pattern projects/{project}/locations/{location}/sources/{source}/datacenterConnectors/{datacenter_connector}.

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.

sourceId string

The Source ID. Must not be null or empty.

datacenterConnectorId string

The DatacenterConnector ID. Must not be null or empty.

Returns
Type Description
DatacenterConnectorName

A new instance of DatacenterConnectorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DatacenterConnectorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DatacenterConnectorName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
DatacenterConnectorName

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

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

Parameter
Name Description
datacenterConnectorName string

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

Returns
Type Description
DatacenterConnectorName

The parsed DatacenterConnectorName if successful.

Remarks

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

  • projects/{project}/locations/{location}/sources/{source}/datacenterConnectors/{datacenter_connector}

Parse(string, bool)

public static DatacenterConnectorName Parse(string datacenterConnectorName, bool allowUnparsed)

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

Parameters
Name Description
datacenterConnectorName 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
DatacenterConnectorName

The parsed DatacenterConnectorName if successful.

Remarks

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

  • projects/{project}/locations/{location}/sources/{source}/datacenterConnectors/{datacenter_connector}
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 DatacenterConnectorName)

public static bool TryParse(string datacenterConnectorName, out DatacenterConnectorName result)

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

Parameters
Name Description
datacenterConnectorName string

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

result DatacenterConnectorName

When this method returns, the parsed DatacenterConnectorName, 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}/sources/{source}/datacenterConnectors/{datacenter_connector}

TryParse(string, bool, out DatacenterConnectorName)

public static bool TryParse(string datacenterConnectorName, bool allowUnparsed, out DatacenterConnectorName result)

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

Parameters
Name Description
datacenterConnectorName 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 DatacenterConnectorName

When this method returns, the parsed DatacenterConnectorName, 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}/sources/{source}/datacenterConnectors/{datacenter_connector}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DatacenterConnectorName, DatacenterConnectorName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DatacenterConnectorName

The first resource name to compare, or null.

b DatacenterConnectorName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DatacenterConnectorName

The first resource name to compare, or null.

b DatacenterConnectorName

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.