Data QnA v1alpha API - Class QuestionName (2.0.0-alpha02)

Version latest

• 2.0.0-alpha02 (latest)
• 2.0.0-alpha01
• 1.0.0-alpha03

public sealed class QuestionName : IResourceName, IEquatable<QuestionName>

Reference documentation and code samples for the Data QnA v1alpha API class QuestionName.

Resource name for the Question resource.

Inheritance

object > QuestionName

Implements

IResourceName, IEquatableQuestionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DataQnA.V1Alpha

Assembly

Google.Cloud.DataQnA.V1Alpha.dll

Constructors

QuestionName(string, string, string)

public QuestionName(string projectId, string locationId, string questionId)

Constructs a new instance of a QuestionName class from the component parts of pattern projects/{project}/locations/{location}/questions/{question}

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.
questionId	string The Question 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

QuestionId

public string QuestionId { get; }

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

Property Value
Type	Description
string

Type

public QuestionName.ResourceNameType Type { get; }

The QuestionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
QuestionNameResourceNameType

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

Formats the IDs into the string representation of this QuestionName with pattern projects/{project}/locations/{location}/questions/{question}.

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.
questionId	string The Question ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this QuestionName with pattern projects/{project}/locations/{location}/questions/{question}.

FormatProjectLocationQuestion(string, string, string)

public static string FormatProjectLocationQuestion(string projectId, string locationId, string questionId)

Formats the IDs into the string representation of this QuestionName with pattern projects/{project}/locations/{location}/questions/{question}.

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.
questionId	string The Question ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this QuestionName with pattern projects/{project}/locations/{location}/questions/{question}.

FromProjectLocationQuestion(string, string, string)

public static QuestionName FromProjectLocationQuestion(string projectId, string locationId, string questionId)

Creates a QuestionName with the pattern projects/{project}/locations/{location}/questions/{question}.

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.
questionId	string The Question ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static QuestionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a QuestionName containing an unparsed resource name.

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

Returns
Type	Description
QuestionName	A new instance of QuestionName 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 QuestionName Parse(string questionName)

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

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

Returns
Type	Description
QuestionName	The parsed QuestionName if successful.

Remarks

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

• projects/{project}/locations/{location}/questions/{question}

Parse(string, bool)

public static QuestionName Parse(string questionName, bool allowUnparsed)

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

Parameters
Name	Description
questionName	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
QuestionName	The parsed QuestionName if successful.

Remarks

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

• projects/{project}/locations/{location}/questions/{question}

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

public static bool TryParse(string questionName, out QuestionName result)

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

Parameters
Name	Description
questionName	string The resource name in string form. Must not be null.
result	QuestionName When this method returns, the parsed QuestionName, 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}/questions/{question}

TryParse(string, bool, out QuestionName)

public static bool TryParse(string questionName, bool allowUnparsed, out QuestionName result)

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

Parameters
Name	Description
questionName	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	QuestionName When this method returns, the parsed QuestionName, 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}/questions/{question}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(QuestionName, QuestionName)

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

Parameters
Name	Description
a	QuestionName
b	QuestionName

Returns
Type	Description
bool

operator !=(QuestionName, QuestionName)

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

Parameters
Name	Description
a	QuestionName
b	QuestionName

Returns
Type	Description
bool