Cloud Location Finder v1 API - Class CloudLocationName (1.0.0-beta01) 

public sealed class CloudLocationName : IResourceName, IEquatable<CloudLocationName>

Reference documentation and code samples for the Cloud Location Finder v1 API class CloudLocationName.

Resource name for the CloudLocation resource.

Inheritance

object > CloudLocationName

Namespace

Google.Cloud.LocationFinder.V1

Assembly

Google.Cloud.LocationFinder.V1.dll

Constructors

CloudLocationName(string, string, string)

public CloudLocationName(string projectId, string locationId, string cloudLocationId)

Constructs a new instance of a CloudLocationName class from the component parts of pattern projects/{project}/locations/{location}/cloudLocations/{cloud_location}

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.
cloudLocationId string

The CloudLocation ID. Must not be null or empty.

Properties

CloudLocationId

public string CloudLocationId { get; }

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

The CloudLocationName.ResourceNameType of the contained resource name.

Property Value
Type Description
CloudLocationNameResourceNameType

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

Formats the IDs into the string representation of this CloudLocationName with pattern projects/{project}/locations/{location}/cloudLocations/{cloud_location}.

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.
cloudLocationId string

The CloudLocation ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this CloudLocationName with pattern projects/{project}/locations/{location}/cloudLocations/{cloud_location}.

FormatProjectLocationCloudLocation(string, string, string)

public static string FormatProjectLocationCloudLocation(string projectId, string locationId, string cloudLocationId)

Formats the IDs into the string representation of this CloudLocationName with pattern projects/{project}/locations/{location}/cloudLocations/{cloud_location}.

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.
cloudLocationId string

The CloudLocation ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this CloudLocationName with pattern projects/{project}/locations/{location}/cloudLocations/{cloud_location}.

FromProjectLocationCloudLocation(string, string, string)

public static CloudLocationName FromProjectLocationCloudLocation(string projectId, string locationId, string cloudLocationId)

Creates a CloudLocationName with the pattern projects/{project}/locations/{location}/cloudLocations/{cloud_location}.

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.
cloudLocationId string

The CloudLocation ID. Must not be null or empty.
Returns
Type Description
CloudLocationName

A new instance of CloudLocationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CloudLocationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CloudLocationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
cloudLocationName string

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

The parsed CloudLocationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/cloudLocations/{cloud_location}

Parse(string, bool)

public static CloudLocationName Parse(string cloudLocationName, bool allowUnparsed)

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

Parameters
Name Description
cloudLocationName 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
CloudLocationName

The parsed CloudLocationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/cloudLocations/{cloud_location}
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 CloudLocationName)

public static bool TryParse(string cloudLocationName, out CloudLocationName result)

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

Parameters
Name Description
cloudLocationName string

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

When this method returns, the parsed CloudLocationName, 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}/cloudLocations/{cloud_location}

TryParse(string, bool, out CloudLocationName)

public static bool TryParse(string cloudLocationName, bool allowUnparsed, out CloudLocationName result)

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

Parameters
Name Description
cloudLocationName 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 CloudLocationName

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

Operators

operator ==(CloudLocationName, CloudLocationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CloudLocationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CloudLocationName

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

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.