Analytics Hub v1 API - Class QueryTemplateName (1.10.0) 

public sealed class QueryTemplateName : IResourceName, IEquatable<QueryTemplateName>

Reference documentation and code samples for the Analytics Hub v1 API class QueryTemplateName.

Resource name for the QueryTemplate resource.

Inheritance

object > QueryTemplateName

Namespace

Google.Cloud.BigQuery.AnalyticsHub.V1

Assembly

Google.Cloud.BigQuery.AnalyticsHub.V1.dll

Constructors

QueryTemplateName(string, string, string, string)

public QueryTemplateName(string projectId, string locationId, string dataExchangeId, string queryTemplateId)

Constructs a new instance of a QueryTemplateName class from the component parts of pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}/queryTemplates/{query_template}

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

The DataExchange ID. Must not be null or empty.
queryTemplateId string

The QueryTemplate ID. Must not be null or empty.

Properties

DataExchangeId

public string DataExchangeId { get; }

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

QueryTemplateId

public string QueryTemplateId { get; }

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

Property Value
Type Description
string

Type

public QueryTemplateName.ResourceNameType Type { get; }

The QueryTemplateName.ResourceNameType of the contained resource name.

Property Value
Type Description
QueryTemplateNameResourceNameType

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

Formats the IDs into the string representation of this QueryTemplateName with pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}/queryTemplates/{query_template} .

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

The DataExchange ID. Must not be null or empty.
queryTemplateId string

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

The string representation of this QueryTemplateName with pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}/queryTemplates/{query_template} .

FormatProjectLocationDataExchangeQueryTemplate(string, string, string, string)

public static string FormatProjectLocationDataExchangeQueryTemplate(string projectId, string locationId, string dataExchangeId, string queryTemplateId)

Formats the IDs into the string representation of this QueryTemplateName with pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}/queryTemplates/{query_template} .

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

The DataExchange ID. Must not be null or empty.
queryTemplateId string

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

The string representation of this QueryTemplateName with pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}/queryTemplates/{query_template} .

FromProjectLocationDataExchangeQueryTemplate(string, string, string, string)

public static QueryTemplateName FromProjectLocationDataExchangeQueryTemplate(string projectId, string locationId, string dataExchangeId, string queryTemplateId)

Creates a QueryTemplateName with the pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}/queryTemplates/{query_template} .

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

The DataExchange ID. Must not be null or empty.
queryTemplateId string

The QueryTemplate ID. Must not be null or empty.
Returns
Type Description
QueryTemplateName

A new instance of QueryTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static QueryTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a QueryTemplateName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
queryTemplateName string

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

The parsed QueryTemplateName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataExchanges/{data_exchange}/queryTemplates/{query_template}

Parse(string, bool)

public static QueryTemplateName Parse(string queryTemplateName, bool allowUnparsed)

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

Parameters
Name Description
queryTemplateName 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
QueryTemplateName

The parsed QueryTemplateName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataExchanges/{data_exchange}/queryTemplates/{query_template}
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 QueryTemplateName)

public static bool TryParse(string queryTemplateName, out QueryTemplateName result)

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

Parameters
Name Description
queryTemplateName string

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

When this method returns, the parsed QueryTemplateName, 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}/dataExchanges/{data_exchange}/queryTemplates/{query_template}

TryParse(string, bool, out QueryTemplateName)

public static bool TryParse(string queryTemplateName, bool allowUnparsed, out QueryTemplateName result)

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

Parameters
Name Description
queryTemplateName 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 QueryTemplateName

When this method returns, the parsed QueryTemplateName, 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}/dataExchanges/{data_exchange}/queryTemplates/{query_template}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(QueryTemplateName, QueryTemplateName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a QueryTemplateName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a QueryTemplateName

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

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.