Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

Discovery Engine v1 API - Class AssistantName (1.9.0)

public sealed class AssistantName : IResourceName, IEquatable<AssistantName>

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

Resource name for the Assistant resource.

Inheritance

object > AssistantName

Implements

IResourceName, IEquatable AssistantName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

AssistantName(string, string, string, string, string)

public AssistantName(string projectId, string locationId, string collectionId, string engineId, string assistantId)

Constructs a new instance of a AssistantName class from the component parts of pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

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.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`engineId`	`string` The `Engine` ID. Must not be `null` or empty.
`assistantId`	`string` The `Assistant` ID. Must not be `null` or empty.

Properties

AssistantId

public string AssistantId { get; }

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

Property Value
Type	Description
`string`

CollectionId

public string CollectionId { get; }

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

Property Value
Type	Description
`string`

EngineId

public string EngineId { get; }

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

The AssistantName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AssistantNameResourceNameType`

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

public static string Format(string projectId, string locationId, string collectionId, string engineId, string assistantId)

Formats the IDs into the string representation of this AssistantName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} .

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.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`engineId`	`string` The `Engine` ID. Must not be `null` or empty.
`assistantId`	`string` The `Assistant` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AssistantName with pattern `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` .

FormatProjectLocationCollectionEngineAssistant(string, string, string, string, string)

public static string FormatProjectLocationCollectionEngineAssistant(string projectId, string locationId, string collectionId, string engineId, string assistantId)

Formats the IDs into the string representation of this AssistantName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} .

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.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`engineId`	`string` The `Engine` ID. Must not be `null` or empty.
`assistantId`	`string` The `Assistant` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AssistantName with pattern `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` .

FromProjectLocationCollectionEngineAssistant(string, string, string, string, string)

public static AssistantName FromProjectLocationCollectionEngineAssistant(string projectId, string locationId, string collectionId, string engineId, string assistantId)

Creates a AssistantName with the pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} .

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.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`engineId`	`string` The `Engine` ID. Must not be `null` or empty.
`assistantId`	`string` The `Assistant` ID. Must not be `null` or empty.

Returns
Type	Description
`AssistantName`	A new instance of AssistantName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AssistantName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AssistantName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`AssistantName`	A new instance of AssistantName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static AssistantName Parse(string assistantName)

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

Parameter
Name	Description
`assistantName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`AssistantName`	The parsed AssistantName if successful.

Remarks

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

projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Parse(string, bool)

public static AssistantName Parse(string assistantName, bool allowUnparsed)

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

Parameters
Name	Description
`assistantName`	`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
`AssistantName`	The parsed AssistantName if successful.

Remarks

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

projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

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

public static bool TryParse(string assistantName, out AssistantName result)

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

Parameters
Name	Description
`assistantName`	`string` The resource name in string form. Must not be `null`.
`result`	`AssistantName` When this method returns, the parsed AssistantName, 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}/collections/{collection}/engines/{engine}/assistants/{assistant}

TryParse(string, bool, out AssistantName)

public static bool TryParse(string assistantName, bool allowUnparsed, out AssistantName result)

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

Parameters
Name	Description
`assistantName`	`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`	`AssistantName` When this method returns, the parsed AssistantName, 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}/collections/{collection}/engines/{engine}/assistants/{assistant}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AssistantName, AssistantName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`AssistantName` The first resource name to compare, or null.
`b`	`AssistantName` 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 !=(AssistantName, AssistantName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`AssistantName` The first resource name to compare, or null.
`b`	`AssistantName` 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.