Google Cloud Asset Inventory v1 API - Class SavedQueryName (3.4.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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

savedQueryIdString

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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

OrganizationId

public string OrganizationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

SavedQueryId

public string SavedQueryId { get; }

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

Property Value
TypeDescription
String

Type

public SavedQueryName.ResourceNameType Type { get; }

The SavedQueryName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SavedQueryName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

savedQueryIdString

The SavedQuery ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

savedQueryIdString

The SavedQuery ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

savedQueryIdString

The SavedQuery ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

savedQueryIdString

The SavedQuery ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

savedQueryIdString

The SavedQuery ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

savedQueryIdString

The SavedQuery ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

savedQueryIdString

The SavedQuery ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
SavedQueryName

A new instance of SavedQueryName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static SavedQueryName Parse(string savedQueryName)

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

Parameter
NameDescription
savedQueryNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
savedQueryNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
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
NameDescription
savedQueryNameString

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

resultSavedQueryName

When this method returns, the parsed SavedQueryName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
savedQueryNameString

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

allowUnparsedBoolean

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.

resultSavedQueryName

When this method returns, the parsed SavedQueryName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(SavedQueryName, SavedQueryName)

public static bool operator ==(SavedQueryName a, SavedQueryName b)
Parameters
NameDescription
aSavedQueryName
bSavedQueryName
Returns
TypeDescription
Boolean

Inequality(SavedQueryName, SavedQueryName)

public static bool operator !=(SavedQueryName a, SavedQueryName b)
Parameters
NameDescription
aSavedQueryName
bSavedQueryName
Returns
TypeDescription
Boolean