Class CompletionConfigName (2.2.0) 

public sealed class CompletionConfigName : IResourceName, IEquatable<CompletionConfigName>

Resource name for the CompletionConfig resource.

Inheritance

Object > CompletionConfigName

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

CompletionConfigName(String, String, String)

public CompletionConfigName(string projectId, string locationId, string catalogId)

Constructs a new instance of a CompletionConfigName class from the component parts of pattern projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig

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.
catalogId String

The Catalog ID. Must not be null or empty.

Properties

CatalogId

public string CatalogId { get; }

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

The CompletionConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
CompletionConfigName.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, String)

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

Formats the IDs into the string representation of this CompletionConfigName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig.

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.
catalogId String

The Catalog ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this CompletionConfigName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig.

FormatProjectLocationCatalog(String, String, String)

public static string FormatProjectLocationCatalog(string projectId, string locationId, string catalogId)

Formats the IDs into the string representation of this CompletionConfigName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig.

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.
catalogId String

The Catalog ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this CompletionConfigName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig.

FromProjectLocationCatalog(String, String, String)

public static CompletionConfigName FromProjectLocationCatalog(string projectId, string locationId, string catalogId)

Creates a CompletionConfigName with the pattern projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig.

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.
catalogId String

The Catalog ID. Must not be null or empty.
Returns
Type Description
CompletionConfigName

A new instance of CompletionConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CompletionConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CompletionConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of CompletionConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static CompletionConfigName Parse(string completionConfigName)

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

Parameter
Name Description
completionConfigName String

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

The parsed CompletionConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig

Parse(String, Boolean)

public static CompletionConfigName Parse(string completionConfigName, bool allowUnparsed)

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

Parameters
Name Description
completionConfigName 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
CompletionConfigName

The parsed CompletionConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig
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 CompletionConfigName)

public static bool TryParse(string completionConfigName, out CompletionConfigName result)

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

Parameters
Name Description
completionConfigName String

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

When this method returns, the parsed CompletionConfigName, 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}/catalogs/{catalog}/completionConfig

TryParse(String, Boolean, out CompletionConfigName)

public static bool TryParse(string completionConfigName, bool allowUnparsed, out CompletionConfigName result)

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

Parameters
Name Description
completionConfigName 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 CompletionConfigName

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

Operators

Equality(CompletionConfigName, CompletionConfigName)

public static bool operator ==(CompletionConfigName a, CompletionConfigName b)
Parameters
Name Description
a CompletionConfigName
b CompletionConfigName
Returns
Type Description
Boolean

Inequality(CompletionConfigName, CompletionConfigName)

public static bool operator !=(CompletionConfigName a, CompletionConfigName b)
Parameters
Name Description
a CompletionConfigName
b CompletionConfigName
Returns
Type Description
Boolean