VM Migration v1 API - Class DatacenterConnectorName (2.3.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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

sourceIdString

The Source ID. Must not be null or empty.

datacenterConnectorIdString

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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

SourceId

public string SourceId { get; }

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

Property Value
TypeDescription
String

Type

public DatacenterConnectorName.ResourceNameType Type { get; }

The DatacenterConnectorName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DatacenterConnectorName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

sourceIdString

The Source ID. Must not be null or empty.

datacenterConnectorIdString

The DatacenterConnector ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

sourceIdString

The Source ID. Must not be null or empty.

datacenterConnectorIdString

The DatacenterConnector ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

sourceIdString

The Source ID. Must not be null or empty.

datacenterConnectorIdString

The DatacenterConnector ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DatacenterConnectorName

A new instance of DatacenterConnectorName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static DatacenterConnectorName Parse(string datacenterConnectorName)

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

Parameter
NameDescription
datacenterConnectorNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
datacenterConnectorNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
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
NameDescription
datacenterConnectorNameString

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

resultDatacenterConnectorName

When this method returns, the parsed DatacenterConnectorName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
datacenterConnectorNameString

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

allowUnparsedBoolean

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.

resultDatacenterConnectorName

When this method returns, the parsed DatacenterConnectorName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(DatacenterConnectorName, DatacenterConnectorName)

public static bool operator ==(DatacenterConnectorName a, DatacenterConnectorName b)
Parameters
NameDescription
aDatacenterConnectorName
bDatacenterConnectorName
Returns
TypeDescription
Boolean

Inequality(DatacenterConnectorName, DatacenterConnectorName)

public static bool operator !=(DatacenterConnectorName a, DatacenterConnectorName b)
Parameters
NameDescription
aDatacenterConnectorName
bDatacenterConnectorName
Returns
TypeDescription
Boolean