Chronicle v1 API - Class DashboardQueryName (1.0.0-beta05) 

public sealed class DashboardQueryName : IResourceName, IEquatable<DashboardQueryName>

Reference documentation and code samples for the Chronicle v1 API class DashboardQueryName.

Resource name for the DashboardQuery resource.

Inheritance

object > DashboardQueryName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

DashboardQueryName(string, string, string, string)

public DashboardQueryName(string projectId, string locationId, string instanceId, string queryId)

Constructs a new instance of a DashboardQueryName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{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.
instanceId string

The Instance ID. Must not be null or empty.
queryId string

The Query ID. Must not be null or empty.

Properties

InstanceId

public string InstanceId { get; }

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

QueryId

public string QueryId { get; }

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

Property Value
Type Description
string

Type

public DashboardQueryName.ResourceNameType Type { get; }

The DashboardQueryName.ResourceNameType of the contained resource name.

Property Value
Type Description
DashboardQueryNameResourceNameType

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 instanceId, string queryId)

Formats the IDs into the string representation of this DashboardQueryName with pattern projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{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.
instanceId string

The Instance ID. Must not be null or empty.
queryId string

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

The string representation of this DashboardQueryName with pattern projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}.

FormatProjectLocationInstanceQuery(string, string, string, string)

public static string FormatProjectLocationInstanceQuery(string projectId, string locationId, string instanceId, string queryId)

Formats the IDs into the string representation of this DashboardQueryName with pattern projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{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.
instanceId string

The Instance ID. Must not be null or empty.
queryId string

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

The string representation of this DashboardQueryName with pattern projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}.

FromProjectLocationInstanceQuery(string, string, string, string)

public static DashboardQueryName FromProjectLocationInstanceQuery(string projectId, string locationId, string instanceId, string queryId)

Creates a DashboardQueryName with the pattern projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{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.
instanceId string

The Instance ID. Must not be null or empty.
queryId string

The Query ID. Must not be null or empty.
Returns
Type Description
DashboardQueryName

A new instance of DashboardQueryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DashboardQueryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DashboardQueryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
dashboardQueryName string

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

The parsed DashboardQueryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}

Parse(string, bool)

public static DashboardQueryName Parse(string dashboardQueryName, bool allowUnparsed)

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

Parameters
Name Description
dashboardQueryName 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
DashboardQueryName

The parsed DashboardQueryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{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 DashboardQueryName)

public static bool TryParse(string dashboardQueryName, out DashboardQueryName result)

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

Parameters
Name Description
dashboardQueryName string

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

When this method returns, the parsed DashboardQueryName, 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}/instances/{instance}/dashboardQueries/{query}

TryParse(string, bool, out DashboardQueryName)

public static bool TryParse(string dashboardQueryName, bool allowUnparsed, out DashboardQueryName result)

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

Parameters
Name Description
dashboardQueryName 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 DashboardQueryName

When this method returns, the parsed DashboardQueryName, 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}/instances/{instance}/dashboardQueries/{query}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DashboardQueryName, DashboardQueryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DashboardQueryName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DashboardQueryName

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

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.