Discovery Engine v1beta API - Class SampleQuerySetName (1.0.0-beta16)

public sealed class SampleQuerySetName : IResourceName, IEquatable<SampleQuerySetName>

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

Resource name for the SampleQuerySet resource.

Inheritance

object > SampleQuerySetName

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

SampleQuerySetName(string, string, string)

public SampleQuerySetName(string projectId, string locationId, string sampleQuerySetId)

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

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.

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

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 SampleQuerySetName.ResourceNameType Type { get; }

The SampleQuerySetName.ResourceNameType of the contained resource name.

Property Value
Type Description
SampleQuerySetNameResourceNameType

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

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

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.

Returns
Type Description
string

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

FormatProjectLocationSampleQuerySet(string, string, string)

public static string FormatProjectLocationSampleQuerySet(string projectId, string locationId, string sampleQuerySetId)

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

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.

Returns
Type Description
string

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

FromProjectLocationSampleQuerySet(string, string, string)

public static SampleQuerySetName FromProjectLocationSampleQuerySet(string projectId, string locationId, string sampleQuerySetId)

Creates a SampleQuerySetName with the pattern projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

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.

Returns
Type Description
SampleQuerySetName

A new instance of SampleQuerySetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SampleQuerySetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SampleQuerySetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
SampleQuerySetName

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

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

Parameter
Name Description
sampleQuerySetName string

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

Returns
Type Description
SampleQuerySetName

The parsed SampleQuerySetName 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}

Parse(string, bool)

public static SampleQuerySetName Parse(string sampleQuerySetName, bool allowUnparsed)

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

Parameters
Name Description
sampleQuerySetName 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
SampleQuerySetName

The parsed SampleQuerySetName 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}
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 SampleQuerySetName)

public static bool TryParse(string sampleQuerySetName, out SampleQuerySetName result)

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

Parameters
Name Description
sampleQuerySetName string

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

result SampleQuerySetName

When this method returns, the parsed SampleQuerySetName, 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}

TryParse(string, bool, out SampleQuerySetName)

public static bool TryParse(string sampleQuerySetName, bool allowUnparsed, out SampleQuerySetName result)

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

Parameters
Name Description
sampleQuerySetName 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 SampleQuerySetName

When this method returns, the parsed SampleQuerySetName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SampleQuerySetName, SampleQuerySetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SampleQuerySetName

The first resource name to compare, or null.

b SampleQuerySetName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SampleQuerySetName

The first resource name to compare, or null.

b SampleQuerySetName

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.