Discovery Engine v1 API - Class AssistAnswerName (1.10.0) 

public sealed class AssistAnswerName : IResourceName, IEquatable<AssistAnswerName>

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

Resource name for the AssistAnswer resource.

Inheritance

object > AssistAnswerName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

AssistAnswerName(string, string, string, string, string, string)

public AssistAnswerName(string projectId, string locationId, string collectionId, string engineId, string sessionId, string assistAnswerId)

Constructs a new instance of a AssistAnswerName class from the component parts of pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

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

The Session ID. Must not be null or empty.
assistAnswerId string

The AssistAnswer ID. Must not be null or empty.

Properties

AssistAnswerId

public string AssistAnswerId { get; }

The AssistAnswer 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

SessionId

public string SessionId { get; }

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

Property Value
Type Description
string

Type

public AssistAnswerName.ResourceNameType Type { get; }

The AssistAnswerName.ResourceNameType of the contained resource name.

Property Value
Type Description
AssistAnswerNameResourceNameType

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

public static string Format(string projectId, string locationId, string collectionId, string engineId, string sessionId, string assistAnswerId)

Formats the IDs into the string representation of this AssistAnswerName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer} .

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

The Session ID. Must not be null or empty.
assistAnswerId string

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

The string representation of this AssistAnswerName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer} .

FormatProjectLocationCollectionEngineSessionAssistAnswer(string, string, string, string, string, string)

public static string FormatProjectLocationCollectionEngineSessionAssistAnswer(string projectId, string locationId, string collectionId, string engineId, string sessionId, string assistAnswerId)

Formats the IDs into the string representation of this AssistAnswerName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer} .

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

The Session ID. Must not be null or empty.
assistAnswerId string

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

The string representation of this AssistAnswerName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer} .

FromProjectLocationCollectionEngineSessionAssistAnswer(string, string, string, string, string, string)

public static AssistAnswerName FromProjectLocationCollectionEngineSessionAssistAnswer(string projectId, string locationId, string collectionId, string engineId, string sessionId, string assistAnswerId)

Creates a AssistAnswerName with the pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer} .

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

The Session ID. Must not be null or empty.
assistAnswerId string

The AssistAnswer ID. Must not be null or empty.
Returns
Type Description
AssistAnswerName

A new instance of AssistAnswerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AssistAnswerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AssistAnswerName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
assistAnswerName string

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

The parsed AssistAnswerName 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}/sessions/{session}/assistAnswers/{assist_answer}

Parse(string, bool)

public static AssistAnswerName Parse(string assistAnswerName, bool allowUnparsed)

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

Parameters
Name Description
assistAnswerName 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
AssistAnswerName

The parsed AssistAnswerName 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}/sessions/{session}/assistAnswers/{assist_answer}
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 AssistAnswerName)

public static bool TryParse(string assistAnswerName, out AssistAnswerName result)

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

Parameters
Name Description
assistAnswerName string

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

When this method returns, the parsed AssistAnswerName, 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}/sessions/{session}/assistAnswers/{assist_answer}

TryParse(string, bool, out AssistAnswerName)

public static bool TryParse(string assistAnswerName, bool allowUnparsed, out AssistAnswerName result)

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

Parameters
Name Description
assistAnswerName 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 AssistAnswerName

When this method returns, the parsed AssistAnswerName, 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}/sessions/{session}/assistAnswers/{assist_answer}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AssistAnswerName, AssistAnswerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AssistAnswerName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AssistAnswerName

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

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.