VMware Engine v1 API - Class PrivateCloudName (1.5.0)

public sealed class PrivateCloudName : IResourceName, IEquatable<PrivateCloudName>

Reference documentation and code samples for the VMware Engine v1 API class PrivateCloudName.

Resource name for the PrivateCloud resource.

Inheritance

object > PrivateCloudName

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

PrivateCloudName(string, string, string)

public PrivateCloudName(string projectId, string locationId, string privateCloudId)

Constructs a new instance of a PrivateCloudName class from the component parts of pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}

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.

privateCloudId string

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

PrivateCloudId

public string PrivateCloudId { get; }

The PrivateCloud 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 PrivateCloudName.ResourceNameType Type { get; }

The PrivateCloudName.ResourceNameType of the contained resource name.

Property Value
Type Description
PrivateCloudNameResourceNameType

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 privateCloudId)

Formats the IDs into the string representation of this PrivateCloudName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}.

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.

privateCloudId string

The PrivateCloud ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this PrivateCloudName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}.

FormatProjectLocationPrivateCloud(string, string, string)

public static string FormatProjectLocationPrivateCloud(string projectId, string locationId, string privateCloudId)

Formats the IDs into the string representation of this PrivateCloudName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}.

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.

privateCloudId string

The PrivateCloud ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this PrivateCloudName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}.

FromProjectLocationPrivateCloud(string, string, string)

public static PrivateCloudName FromProjectLocationPrivateCloud(string projectId, string locationId, string privateCloudId)

Creates a PrivateCloudName with the pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}.

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.

privateCloudId string

The PrivateCloud ID. Must not be null or empty.

Returns
Type Description
PrivateCloudName

A new instance of PrivateCloudName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PrivateCloudName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PrivateCloudName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
PrivateCloudName

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

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

Parameter
Name Description
privateCloudName string

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

Returns
Type Description
PrivateCloudName

The parsed PrivateCloudName if successful.

Remarks

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

  • projects/{project}/locations/{location}/privateClouds/{private_cloud}

Parse(string, bool)

public static PrivateCloudName Parse(string privateCloudName, bool allowUnparsed)

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

Parameters
Name Description
privateCloudName 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
PrivateCloudName

The parsed PrivateCloudName if successful.

Remarks

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

  • projects/{project}/locations/{location}/privateClouds/{private_cloud}
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 PrivateCloudName)

public static bool TryParse(string privateCloudName, out PrivateCloudName result)

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

Parameters
Name Description
privateCloudName string

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

result PrivateCloudName

When this method returns, the parsed PrivateCloudName, 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}/privateClouds/{private_cloud}

TryParse(string, bool, out PrivateCloudName)

public static bool TryParse(string privateCloudName, bool allowUnparsed, out PrivateCloudName result)

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

Parameters
Name Description
privateCloudName 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 PrivateCloudName

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

Operators

operator ==(PrivateCloudName, PrivateCloudName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PrivateCloudName

The first resource name to compare, or null.

b PrivateCloudName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PrivateCloudName

The first resource name to compare, or null.

b PrivateCloudName

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.