Class LocationName (4.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class LocationName : IResourceName, IEquatable<LocationName>

Resource name for the 'location' resource which is widespread across Google Cloud Platform. While most resource names are generated on a per-API basis, many APIs use a location resource, and it's useful to be able to pass values from one API to another.

Inheritance

Object > LocationName

Namespace

Google.Api.Gax.ResourceNames

Assembly

Google.Api.Gax.dll

Constructors

LocationName(String, String)

public LocationName(string projectId, string locationId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

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

Type

public LocationName.ResourceNameType Type { get; }

The LocationName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
LocationName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Equals(LocationName)

public bool Equals(LocationName other)
Parameter
NameDescription
otherLocationName
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
Boolean
Overrides

Format(String, String)

public static string Format(string projectId, string locationId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this LocationName with pattern projects/{project}/locations/{location}.

FormatProjectLocation(String, String)

public static string FormatProjectLocation(string projectId, string locationId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this LocationName with pattern projects/{project}/locations/{location}.

FromProjectLocation(String, String)

public static LocationName FromProjectLocation(string projectId, string locationId)

Creates a LocationName with the pattern projects/{project}/locations/{location}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
LocationName

A new instance of LocationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LocationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LocationName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
LocationName

A new instance of LocationName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32
Overrides

Parse(String)

public static LocationName Parse(string locationName)

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

Parameter
NameDescription
locationNameString

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

Returns
TypeDescription
LocationName

The parsed LocationName if successful.

Remarks

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

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

Parse(String, Boolean)

public static LocationName Parse(string locationName, bool allowUnparsed)

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

Parameters
NameDescription
locationNameString

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
LocationName

The parsed LocationName if successful.

Remarks

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

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

public static bool TryParse(string locationName, out LocationName result)

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

Parameters
NameDescription
locationNameString

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

resultLocationName

When this method returns, the parsed LocationName, 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}

TryParse(String, Boolean, out LocationName)

public static bool TryParse(string locationName, bool allowUnparsed, out LocationName result)

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

Parameters
NameDescription
locationNameString

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.

resultLocationName

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

Operators

Equality(LocationName, LocationName)

public static bool operator ==(LocationName a, LocationName b)
Parameters
NameDescription
aLocationName
bLocationName
Returns
TypeDescription
Boolean

Inequality(LocationName, LocationName)

public static bool operator !=(LocationName a, LocationName b)
Parameters
NameDescription
aLocationName
bLocationName
Returns
TypeDescription
Boolean