Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class LocationName (4.4.0)

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

Implements

IResourceName, IEquatable LocationName

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` 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
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 LocationName.ResourceNameType Type { get; }

The LocationName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`LocationNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`UnparsedResourceName`

Methods

Equals(LocationName)

public bool Equals(LocationName other)

Parameter
Name	Description
`other`	`LocationName`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object obj)

Parameter
Name	Description
`obj`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`LocationName`	A new instance of LocationName containing the provided `unparsedResourceName` .

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static LocationName Parse(string locationName)

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

Parameter
Name	Description
`locationName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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, bool)

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
Name	Description
`locationName`	`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
`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()

Returns
Type	Description
`string`

Overrides

object.ToString()

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
Name	Description
`locationName`	`string` The resource name in string form. Must not be `null`.
`result`	`LocationName` When this method returns, the parsed LocationName, 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}

TryParse(string, bool, 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
Name	Description
`locationName`	`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`	`LocationName` When this method returns, the parsed LocationName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LocationName, LocationName)

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

Parameters
Name	Description
`a`	`LocationName`
`b`	`LocationName`

Returns
Type	Description
`bool`

operator !=(LocationName, LocationName)

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

Parameters
Name	Description
`a`	`LocationName`
`b`	`LocationName`

Returns
Type	Description
`bool`