Google Cloud Asset Inventory v1 API - Class SavedQueryName (3.14.0) 

public sealed class SavedQueryName : IResourceName, IEquatable<SavedQueryName>

Reference documentation and code samples for the Google Cloud Asset Inventory v1 API class SavedQueryName.

Resource name for the SavedQuery resource.

Inheritance

object > SavedQueryName

Namespace

Google.Cloud.Asset.V1

Assembly

Google.Cloud.Asset.V1.dll

Constructors

SavedQueryName(string, string)

public SavedQueryName(string projectId, string savedQueryId)

Constructs a new instance of a SavedQueryName class from the component parts of pattern projects/{project}/savedQueries/{saved_query}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
savedQueryId string

The SavedQuery ID. Must not be null or empty.

Properties

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

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

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

SavedQueryId

public string SavedQueryId { get; }

The SavedQuery ID. May be null, depending on which resource name is contained by this instance.

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)

public static string Format(string projectId, string savedQueryId)

Formats the IDs into the string representation of this SavedQueryName with pattern projects/{project}/savedQueries/{saved_query}.

Parameters
Name Description
projectId string

The Project 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}/savedQueries/{saved_query}.

FormatFolderSavedQuery(string, string)

public static string FormatFolderSavedQuery(string folderId, string savedQueryId)

Formats the IDs into the string representation of this SavedQueryName with pattern folders/{folder}/savedQueries/{saved_query}.

Parameters
Name Description
folderId string

The Folder 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 folders/{folder}/savedQueries/{saved_query}.

FormatOrganizationSavedQuery(string, string)

public static string FormatOrganizationSavedQuery(string organizationId, string savedQueryId)

Formats the IDs into the string representation of this SavedQueryName with pattern organizations/{organization}/savedQueries/{saved_query}.

Parameters
Name Description
organizationId string

The Organization 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 organizations/{organization}/savedQueries/{saved_query}.

FormatProjectSavedQuery(string, string)

public static string FormatProjectSavedQuery(string projectId, string savedQueryId)

Formats the IDs into the string representation of this SavedQueryName with pattern projects/{project}/savedQueries/{saved_query}.

Parameters
Name Description
projectId string

The Project 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}/savedQueries/{saved_query}.

FromFolderSavedQuery(string, string)

public static SavedQueryName FromFolderSavedQuery(string folderId, string savedQueryId)

Creates a SavedQueryName with the pattern folders/{folder}/savedQueries/{saved_query}.

Parameters
Name Description
folderId string

The Folder 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.

FromOrganizationSavedQuery(string, string)

public static SavedQueryName FromOrganizationSavedQuery(string organizationId, string savedQueryId)

Creates a SavedQueryName with the pattern organizations/{organization}/savedQueries/{saved_query}.

Parameters
Name Description
organizationId string

The Organization 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.

FromProjectSavedQuery(string, string)

public static SavedQueryName FromProjectSavedQuery(string projectId, string savedQueryId)

Creates a SavedQueryName with the pattern projects/{project}/savedQueries/{saved_query} .

Parameters
Name Description
projectId string

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

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}/savedQueries/{saved_query}
  • folders/{folder}/savedQueries/{saved_query}
  • organizations/{organization}/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}/savedQueries/{saved_query}
  • folders/{folder}/savedQueries/{saved_query}
  • organizations/{organization}/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

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}/savedQueries/{saved_query}
  • folders/{folder}/savedQueries/{saved_query}
  • organizations/{organization}/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}/savedQueries/{saved_query}
  • folders/{folder}/savedQueries/{saved_query}
  • organizations/{organization}/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.