Discovery Engine v1 API - Class IdentityMappingStoreName (1.8.0) 

public sealed class IdentityMappingStoreName : IResourceName, IEquatable<IdentityMappingStoreName>

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

Resource name for the IdentityMappingStore resource.

Inheritance

object > IdentityMappingStoreName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

IdentityMappingStoreName(string, string, string)

public IdentityMappingStoreName(string projectId, string locationId, string identityMappingStoreId)

Constructs a new instance of a IdentityMappingStoreName class from the component parts of pattern projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_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.
identityMappingStoreId string

The IdentityMappingStore ID. Must not be null or empty.

Properties

IdentityMappingStoreId

public string IdentityMappingStoreId { get; }

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

Property Value
Type Description
string

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 IdentityMappingStoreName.ResourceNameType Type { get; }

The IdentityMappingStoreName.ResourceNameType of the contained resource name.

Property Value
Type Description
IdentityMappingStoreNameResourceNameType

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, string)

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

Formats the IDs into the string representation of this IdentityMappingStoreName with pattern projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_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.
identityMappingStoreId string

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

The string representation of this IdentityMappingStoreName with pattern projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.

FormatProjectLocationIdentityMappingStore(string, string, string)

public static string FormatProjectLocationIdentityMappingStore(string projectId, string locationId, string identityMappingStoreId)

Formats the IDs into the string representation of this IdentityMappingStoreName with pattern projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_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.
identityMappingStoreId string

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

The string representation of this IdentityMappingStoreName with pattern projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.

FromProjectLocationIdentityMappingStore(string, string, string)

public static IdentityMappingStoreName FromProjectLocationIdentityMappingStore(string projectId, string locationId, string identityMappingStoreId)

Creates a IdentityMappingStoreName with the pattern projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_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.
identityMappingStoreId string

The IdentityMappingStore ID. Must not be null or empty.
Returns
Type Description
IdentityMappingStoreName

A new instance of IdentityMappingStoreName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static IdentityMappingStoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a IdentityMappingStoreName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
identityMappingStoreName string

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

The parsed IdentityMappingStoreName if successful.
Remarks

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

  • projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}

Parse(string, bool)

public static IdentityMappingStoreName Parse(string identityMappingStoreName, bool allowUnparsed)

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

Parameters
Name Description
identityMappingStoreName 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
IdentityMappingStoreName

The parsed IdentityMappingStoreName if successful.
Remarks

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

  • projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_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 IdentityMappingStoreName)

public static bool TryParse(string identityMappingStoreName, out IdentityMappingStoreName result)

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

Parameters
Name Description
identityMappingStoreName string

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

When this method returns, the parsed IdentityMappingStoreName, 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}/identityMappingStores/{identity_mapping_store}

TryParse(string, bool, out IdentityMappingStoreName)

public static bool TryParse(string identityMappingStoreName, bool allowUnparsed, out IdentityMappingStoreName result)

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

Parameters
Name Description
identityMappingStoreName 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 IdentityMappingStoreName

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

Operators

operator ==(IdentityMappingStoreName, IdentityMappingStoreName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a IdentityMappingStoreName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a IdentityMappingStoreName

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

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.