Oracle Database@Google Cloud v1 API - Class CloudVmClusterName (1.0.0-beta01)

public sealed class CloudVmClusterName : IResourceName, IEquatable<CloudVmClusterName>

Reference documentation and code samples for the Oracle Database@Google Cloud v1 API class CloudVmClusterName.

Resource name for the CloudVmCluster resource.

Inheritance

object > CloudVmClusterName

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

CloudVmClusterName(string, string, string)

public CloudVmClusterName(string projectId, string locationId, string cloudVmClusterId)

Constructs a new instance of a CloudVmClusterName class from the component parts of pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}

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.

cloudVmClusterId string

The CloudVmCluster ID. Must not be null or empty.

Properties

CloudVmClusterId

public string CloudVmClusterId { get; }

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

Type

public CloudVmClusterName.ResourceNameType Type { get; }

The CloudVmClusterName.ResourceNameType of the contained resource name.

Property Value
Type Description
CloudVmClusterNameResourceNameType

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

Formats the IDs into the string representation of this CloudVmClusterName with pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.

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.

cloudVmClusterId string

The CloudVmCluster ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this CloudVmClusterName with pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.

FormatProjectLocationCloudVmCluster(string, string, string)

public static string FormatProjectLocationCloudVmCluster(string projectId, string locationId, string cloudVmClusterId)

Formats the IDs into the string representation of this CloudVmClusterName with pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.

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.

cloudVmClusterId string

The CloudVmCluster ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this CloudVmClusterName with pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.

FromProjectLocationCloudVmCluster(string, string, string)

public static CloudVmClusterName FromProjectLocationCloudVmCluster(string projectId, string locationId, string cloudVmClusterId)

Creates a CloudVmClusterName with the pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.

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.

cloudVmClusterId string

The CloudVmCluster ID. Must not be null or empty.

Returns
Type Description
CloudVmClusterName

A new instance of CloudVmClusterName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CloudVmClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CloudVmClusterName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
CloudVmClusterName

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

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

Parameter
Name Description
cloudVmClusterName string

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

Returns
Type Description
CloudVmClusterName

The parsed CloudVmClusterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}

Parse(string, bool)

public static CloudVmClusterName Parse(string cloudVmClusterName, bool allowUnparsed)

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

Parameters
Name Description
cloudVmClusterName 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
CloudVmClusterName

The parsed CloudVmClusterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}
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 CloudVmClusterName)

public static bool TryParse(string cloudVmClusterName, out CloudVmClusterName result)

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

Parameters
Name Description
cloudVmClusterName string

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

result CloudVmClusterName

When this method returns, the parsed CloudVmClusterName, 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}/cloudVmClusters/{cloud_vm_cluster}

TryParse(string, bool, out CloudVmClusterName)

public static bool TryParse(string cloudVmClusterName, bool allowUnparsed, out CloudVmClusterName result)

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

Parameters
Name Description
cloudVmClusterName 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 CloudVmClusterName

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

Operators

operator ==(CloudVmClusterName, CloudVmClusterName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CloudVmClusterName

The first resource name to compare, or null.

b CloudVmClusterName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CloudVmClusterName

The first resource name to compare, or null.

b CloudVmClusterName

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.