Discovery Engine v1beta API - Class SampleQueryName (1.0.0-beta21) 

public sealed class SampleQueryName : IResourceName, IEquatable<SampleQueryName>

Reference documentation and code samples for the Discovery Engine v1beta API class SampleQueryName.

Resource name for the SampleQuery resource.

Inheritance

object > SampleQueryName

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

SampleQueryName(string, string, string, string)

public SampleQueryName(string projectId, string locationId, string sampleQuerySetId, string sampleQueryId)

Constructs a new instance of a SampleQueryName class from the component parts of pattern projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}

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

The SampleQuerySet ID. Must not be null or empty.
sampleQueryId string

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

SampleQueryId

public string SampleQueryId { get; }

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

Property Value
Type Description
string

SampleQuerySetId

public string SampleQuerySetId { get; }

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

Property Value
Type Description
string

Type

public SampleQueryName.ResourceNameType Type { get; }

The SampleQueryName.ResourceNameType of the contained resource name.

Property Value
Type Description
SampleQueryNameResourceNameType

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)

public static string Format(string projectId, string locationId, string sampleQuerySetId, string sampleQueryId)

Formats the IDs into the string representation of this SampleQueryName with pattern projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query} .

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

The SampleQuerySet ID. Must not be null or empty.
sampleQueryId string

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

The string representation of this SampleQueryName with pattern projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query} .

FormatProjectLocationSampleQuerySetSampleQuery(string, string, string, string)

public static string FormatProjectLocationSampleQuerySetSampleQuery(string projectId, string locationId, string sampleQuerySetId, string sampleQueryId)

Formats the IDs into the string representation of this SampleQueryName with pattern projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query} .

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

The SampleQuerySet ID. Must not be null or empty.
sampleQueryId string

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

The string representation of this SampleQueryName with pattern projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query} .

FromProjectLocationSampleQuerySetSampleQuery(string, string, string, string)

public static SampleQueryName FromProjectLocationSampleQuerySetSampleQuery(string projectId, string locationId, string sampleQuerySetId, string sampleQueryId)

Creates a SampleQueryName with the pattern projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query} .

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

The SampleQuerySet ID. Must not be null or empty.
sampleQueryId string

The SampleQuery ID. Must not be null or empty.
Returns
Type Description
SampleQueryName

A new instance of SampleQueryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SampleQueryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SampleQueryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
sampleQueryName string

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

The parsed SampleQueryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}

Parse(string, bool)

public static SampleQueryName Parse(string sampleQueryName, bool allowUnparsed)

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

Parameters
Name Description
sampleQueryName 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
SampleQueryName

The parsed SampleQueryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}
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 SampleQueryName)

public static bool TryParse(string sampleQueryName, out SampleQueryName result)

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

Parameters
Name Description
sampleQueryName string

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

When this method returns, the parsed SampleQueryName, 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}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}

TryParse(string, bool, out SampleQueryName)

public static bool TryParse(string sampleQueryName, bool allowUnparsed, out SampleQueryName result)

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

Parameters
Name Description
sampleQueryName 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 SampleQueryName

When this method returns, the parsed SampleQueryName, 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}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SampleQueryName, SampleQueryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SampleQueryName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SampleQueryName

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

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.