Chronicle v1 API - Class DashboardChartName (1.0.0-beta05) 

public sealed class DashboardChartName : IResourceName, IEquatable<DashboardChartName>

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

Resource name for the DashboardChart resource.

Inheritance

object > DashboardChartName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

DashboardChartName(string, string, string, string)

public DashboardChartName(string projectId, string locationId, string instanceId, string chartId)

Constructs a new instance of a DashboardChartName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}

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

The Chart ID. Must not be null or empty.

Properties

ChartId

public string ChartId { get; }

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

Property Value
Type Description
string

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

Type

public DashboardChartName.ResourceNameType Type { get; }

The DashboardChartName.ResourceNameType of the contained resource name.

Property Value
Type Description
DashboardChartNameResourceNameType

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 chartId)

Formats the IDs into the string representation of this DashboardChartName with pattern projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}.

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

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

The string representation of this DashboardChartName with pattern projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}.

FormatProjectLocationInstanceChart(string, string, string, string)

public static string FormatProjectLocationInstanceChart(string projectId, string locationId, string instanceId, string chartId)

Formats the IDs into the string representation of this DashboardChartName with pattern projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}.

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

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

The string representation of this DashboardChartName with pattern projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}.

FromProjectLocationInstanceChart(string, string, string, string)

public static DashboardChartName FromProjectLocationInstanceChart(string projectId, string locationId, string instanceId, string chartId)

Creates a DashboardChartName with the pattern projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}.

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

The Chart ID. Must not be null or empty.
Returns
Type Description
DashboardChartName

A new instance of DashboardChartName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DashboardChartName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DashboardChartName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
dashboardChartName string

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

The parsed DashboardChartName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}

Parse(string, bool)

public static DashboardChartName Parse(string dashboardChartName, bool allowUnparsed)

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

Parameters
Name Description
dashboardChartName 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
DashboardChartName

The parsed DashboardChartName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}

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 DashboardChartName)

public static bool TryParse(string dashboardChartName, out DashboardChartName result)

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

Parameters
Name Description
dashboardChartName string

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

When this method returns, the parsed DashboardChartName, 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}/dashboardCharts/{chart}

TryParse(string, bool, out DashboardChartName)

public static bool TryParse(string dashboardChartName, bool allowUnparsed, out DashboardChartName result)

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

Parameters
Name Description
dashboardChartName 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 DashboardChartName

When this method returns, the parsed DashboardChartName, 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}/dashboardCharts/{chart}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DashboardChartName, DashboardChartName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DashboardChartName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DashboardChartName

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

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.