Discovery Engine v1 API - Class UserStoreName (1.8.0) 

public sealed class UserStoreName : IResourceName, IEquatable<UserStoreName>

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

Resource name for the UserStore resource.

Inheritance

object > UserStoreName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

UserStoreName(string, string, string)

public UserStoreName(string projectId, string locationId, string userStoreId)

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

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.
userStoreId string

The UserStore 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 UserStoreName.ResourceNameType Type { get; }

The UserStoreName.ResourceNameType of the contained resource name.

Property Value
Type Description
UserStoreNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

UserStoreId

public string UserStoreId { get; }

The UserStore ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string userStoreId)

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

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.
userStoreId string

The UserStore ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this UserStoreName with pattern projects/{project}/locations/{location}/userStores/{user_store}.

FormatProjectLocationUserStore(string, string, string)

public static string FormatProjectLocationUserStore(string projectId, string locationId, string userStoreId)

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

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.
userStoreId string

The UserStore ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this UserStoreName with pattern projects/{project}/locations/{location}/userStores/{user_store}.

FromProjectLocationUserStore(string, string, string)

public static UserStoreName FromProjectLocationUserStore(string projectId, string locationId, string userStoreId)

Creates a UserStoreName with the pattern projects/{project}/locations/{location}/userStores/{user_store}.

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.
userStoreId string

The UserStore ID. Must not be null or empty.
Returns
Type Description
UserStoreName

A new instance of UserStoreName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static UserStoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UserStoreName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
UserStoreName

A new instance of UserStoreName 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 UserStoreName Parse(string userStoreName)

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

Parameter
Name Description
userStoreName string

The resource name in string form. Must not be null.
Returns
Type Description
UserStoreName

The parsed UserStoreName if successful.
Remarks

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

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

Parse(string, bool)

public static UserStoreName Parse(string userStoreName, bool allowUnparsed)

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

Parameters
Name Description
userStoreName 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
UserStoreName

The parsed UserStoreName if successful.
Remarks

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

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

public static bool TryParse(string userStoreName, out UserStoreName result)

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

Parameters
Name Description
userStoreName string

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

When this method returns, the parsed UserStoreName, 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}/userStores/{user_store}

TryParse(string, bool, out UserStoreName)

public static bool TryParse(string userStoreName, bool allowUnparsed, out UserStoreName result)

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

Parameters
Name Description
userStoreName 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 UserStoreName

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

Operators

operator ==(UserStoreName, UserStoreName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a UserStoreName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a UserStoreName

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

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.