Discovery Engine v1 API - Class LocationName (1.10.0) 

public sealed class LocationName : IResourceName, IEquatable<LocationName>

Reference documentation and code samples for the Discovery Engine v1 API class LocationName.

Resource name for the Location resource.

Inheritance

object > LocationName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.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
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-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
int
Overrides

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

The string representation of the resource name.

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LocationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LocationName

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

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.