Class 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

System.Object

LocationName

Implements

IResourceName

System.IEquatable<LocationName>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Api.Gax.ResourceNames

Assembly: Google.Api.Gax.dll

Syntax

public sealed class LocationName : IResourceName, IEquatable<LocationName>

Constructors

LocationName(String, String)

Constructs a new instance of the LocationName resource name class from its component parts.

Declaration

public LocationName(string projectId, string locationId)

Parameters

Type	Name	Description
System.String	projectId	The project ID. Must not be null.
System.String	locationId	The location ID. Must not be null.

Properties

Kind

The kind of resource name.

Declaration

public ResourceNameKind Kind { get; }

Property Value

Type	Description
ResourceNameKind

Implements

IResourceName.Kind

LocationId

The location ID. Never null.

Declaration

public string LocationId { get; }

Property Value

Type	Description
System.String

ProjectId

The project ID. Never null.

Declaration

public string ProjectId { get; }

Property Value

Type	Description
System.String

Methods

Equals(LocationName)

Declaration

public bool Equals(LocationName other)

Parameters

Type	Name	Description
LocationName	other

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

Format(String, String)

Formats the IDs into the string representation of the LocationName.

Declaration

public static string Format(string projectId, string locationId)

Parameters

Type	Name	Description
System.String	projectId	The project ID. Must not be null.
System.String	locationId	The location ID. Must not be null.

Returns

Type	Description
System.String	The string representation of the LocationName.

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static LocationName Parse(string locationName)

Parameters

Type	Name	Description
System.String	locationName	The location resource name in string form. Must not be null.

Returns

Type	Description
LocationName	The parsed LocationName if successful.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out LocationName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	locationName	The location resource name in string form. Must not be null.
LocationName	result	When this method returns, the parsed LocationName, or null if parsing fails.

Returns

Type	Description
System.Boolean	true if the name was parsed successfully; false otherwise.

Remarks

This method still throws System.ArgumentNullException if locationName is null, as this would usually indicate a programming error rather than a data error.

Operators

Equality(LocationName, LocationName)

Declaration

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

Parameters

Type	Name	Description
LocationName	a
LocationName	b

Returns

Type	Description
System.Boolean

Inequality(LocationName, LocationName)

Declaration

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

Parameters

Type	Name	Description
LocationName	a
LocationName	b

Returns

Type	Description
System.Boolean