Gemini Enterprise for Customer Experience v1beta API - Class DashboardName (1.0.0-beta10) 

public sealed class DashboardName : IResourceName, IEquatable<DashboardName>

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1beta API class DashboardName.

Resource name for the Dashboard resource.

Inheritance

object > DashboardName

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

DashboardName(string, string, string)

public DashboardName(string projectId, string locationId, string dashboardId)

Constructs a new instance of a DashboardName class from the component parts of pattern projects/{project}/locations/{location}/dashboards/{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.
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

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 DashboardName.ResourceNameType Type { get; }

The DashboardName.ResourceNameType of the contained resource name.

Property Value
Type Description
DashboardNameResourceNameType

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)

public static string Format(string projectId, string locationId, string dashboardId)

Formats the IDs into the string representation of this DashboardName with pattern projects/{project}/locations/{location}/dashboards/{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.
dashboardId string

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

The string representation of this DashboardName with pattern projects/{project}/locations/{location}/dashboards/{dashboard}.

FormatProjectLocationDashboard(string, string, string)

public static string FormatProjectLocationDashboard(string projectId, string locationId, string dashboardId)

Formats the IDs into the string representation of this DashboardName with pattern projects/{project}/locations/{location}/dashboards/{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.
dashboardId string

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

The string representation of this DashboardName with pattern projects/{project}/locations/{location}/dashboards/{dashboard}.

FromProjectLocationDashboard(string, string, string)

public static DashboardName FromProjectLocationDashboard(string projectId, string locationId, string dashboardId)

Creates a DashboardName with the pattern projects/{project}/locations/{location}/dashboards/{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.
dashboardId string

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

A new instance of DashboardName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DashboardName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DashboardName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
dashboardName string

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

The parsed DashboardName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dashboards/{dashboard}

Parse(string, bool)

public static DashboardName Parse(string dashboardName, bool allowUnparsed)

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

Parameters
Name Description
dashboardName 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
DashboardName

The parsed DashboardName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dashboards/{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 DashboardName)

public static bool TryParse(string dashboardName, out DashboardName result)

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

Parameters
Name Description
dashboardName string

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

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

TryParse(string, bool, out DashboardName)

public static bool TryParse(string dashboardName, bool allowUnparsed, out DashboardName result)

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

Parameters
Name Description
dashboardName 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 DashboardName

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DashboardName, DashboardName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DashboardName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DashboardName

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

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.