Cloud AI Platform v1 API - Class SavedQueryName (3.5.0)

Version 3.5.0

• 3.10.0 (latest)
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class SavedQueryName : IResourceName, IEquatable<SavedQueryName>

Reference documentation and code samples for the Cloud AI Platform v1 API class SavedQueryName.

Resource name for the SavedQuery resource.

Inheritance

object > SavedQueryName

Implements

IResourceName, IEquatableSavedQueryName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

SavedQueryName(string, string, string, string)

public SavedQueryName(string projectId, string locationId, string datasetId, string savedQueryId)

Constructs a new instance of a SavedQueryName class from the component parts of pattern projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_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.
datasetId	string The Dataset ID. Must not be null or empty.
savedQueryId	string The SavedQuery ID. Must not be null or empty.

Properties

DatasetId

public string DatasetId { get; }

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

SavedQueryId

public string SavedQueryId { get; }

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

Property Value
Type	Description
string

Type

public SavedQueryName.ResourceNameType Type { get; }

The SavedQueryName.ResourceNameType of the contained resource name.

Property Value
Type	Description
SavedQueryNameResourceNameType

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

Formats the IDs into the string representation of this SavedQueryName with pattern projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_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.
datasetId	string The Dataset ID. Must not be null or empty.
savedQueryId	string The SavedQuery ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SavedQueryName with pattern projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}.

FormatProjectLocationDatasetSavedQuery(string, string, string, string)

public static string FormatProjectLocationDatasetSavedQuery(string projectId, string locationId, string datasetId, string savedQueryId)

Formats the IDs into the string representation of this SavedQueryName with pattern projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_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.
datasetId	string The Dataset ID. Must not be null or empty.
savedQueryId	string The SavedQuery ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SavedQueryName with pattern projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}.

FromProjectLocationDatasetSavedQuery(string, string, string, string)

public static SavedQueryName FromProjectLocationDatasetSavedQuery(string projectId, string locationId, string datasetId, string savedQueryId)

Creates a SavedQueryName with the pattern projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_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.
datasetId	string The Dataset ID. Must not be null or empty.
savedQueryId	string The SavedQuery ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static SavedQueryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SavedQueryName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
SavedQueryName	The parsed SavedQueryName if successful.

Remarks

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

• projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}

Parse(string, bool)

public static SavedQueryName Parse(string savedQueryName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_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

object.ToString()

TryParse(string, out SavedQueryName)

public static bool TryParse(string savedQueryName, out SavedQueryName result)

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

Parameters
Name	Description
savedQueryName	string The resource name in string form. Must not be null.
result	SavedQueryName When this method returns, the parsed SavedQueryName, 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}/datasets/{dataset}/savedQueries/{saved_query}

TryParse(string, bool, out SavedQueryName)

public static bool TryParse(string savedQueryName, bool allowUnparsed, out SavedQueryName result)

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

Parameters
Name	Description
savedQueryName	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	SavedQueryName When this method returns, the parsed SavedQueryName, 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}/datasets/{dataset}/savedQueries/{saved_query}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SavedQueryName, SavedQueryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	SavedQueryName The first resource name to compare, or null.
b	SavedQueryName 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 !=(SavedQueryName, SavedQueryName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	SavedQueryName The first resource name to compare, or null.
b	SavedQueryName 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.