Chronicle v1 API - Class NativeDashboardName (1.0.0-beta05) 

public sealed class NativeDashboardName : IResourceName, IEquatable<NativeDashboardName>

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

Resource name for the NativeDashboard resource.

Inheritance

object > NativeDashboardName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

NativeDashboardName(string, string, string, string)

public NativeDashboardName(string projectId, string locationId, string instanceId, string dashboardId)

Constructs a new instance of a NativeDashboardName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}

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

The Dashboard ID. Must not be null or empty.

Properties

DashboardId

public string DashboardId { get; }

The Dashboard 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 NativeDashboardName.ResourceNameType Type { get; }

The NativeDashboardName.ResourceNameType of the contained resource name.

Property Value
Type Description
NativeDashboardNameResourceNameType

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

Formats the IDs into the string representation of this NativeDashboardName with pattern projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}.

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

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

The string representation of this NativeDashboardName with pattern projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}.

FormatProjectLocationInstanceDashboard(string, string, string, string)

public static string FormatProjectLocationInstanceDashboard(string projectId, string locationId, string instanceId, string dashboardId)

Formats the IDs into the string representation of this NativeDashboardName with pattern projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}.

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

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

The string representation of this NativeDashboardName with pattern projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}.

FromProjectLocationInstanceDashboard(string, string, string, string)

public static NativeDashboardName FromProjectLocationInstanceDashboard(string projectId, string locationId, string instanceId, string dashboardId)

Creates a NativeDashboardName with the pattern projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}.

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

The Dashboard ID. Must not be null or empty.
Returns
Type Description
NativeDashboardName

A new instance of NativeDashboardName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NativeDashboardName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NativeDashboardName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
nativeDashboardName string

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

The parsed NativeDashboardName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}

Parse(string, bool)

public static NativeDashboardName Parse(string nativeDashboardName, bool allowUnparsed)

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

Parameters
Name Description
nativeDashboardName 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
NativeDashboardName

The parsed NativeDashboardName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}

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

public static bool TryParse(string nativeDashboardName, out NativeDashboardName result)

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

Parameters
Name Description
nativeDashboardName string

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

When this method returns, the parsed NativeDashboardName, 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}/nativeDashboards/{dashboard}

TryParse(string, bool, out NativeDashboardName)

public static bool TryParse(string nativeDashboardName, bool allowUnparsed, out NativeDashboardName result)

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

Parameters
Name Description
nativeDashboardName 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 NativeDashboardName

When this method returns, the parsed NativeDashboardName, 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}/nativeDashboards/{dashboard}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NativeDashboardName, NativeDashboardName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a NativeDashboardName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a NativeDashboardName

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

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.