Class LocationName (3.0.0)

public sealed class LocationName : IResourceName, IEquatable<LocationName>

Resource name for the Location resource.

Inheritance

Object > LocationName

Implements

IResourceName, IEquatable<LocationName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.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
`Boolean`

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
`LocationName.ResourceNameType`

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)

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 a hash code for this resource name.

Returns
Type	Description
`Int32`

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, 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
Name	Description
`locationName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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()

The string representation of the resource name.

Returns
Type	Description
`String`	The string representation of the resource name.

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
`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
Name	Description
`locationName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`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
Name	Description
`a`	`LocationName`
`b`	`LocationName`

Returns
Type	Description
`Boolean`

Inequality(LocationName, LocationName)

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

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

Returns
Type	Description
`Boolean`