Chronicle v1 API - Class FeaturedContentNativeDashboardName (1.0.0-beta05) 

public sealed class FeaturedContentNativeDashboardName : IResourceName, IEquatable<FeaturedContentNativeDashboardName>

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

Resource name for the FeaturedContentNativeDashboard resource.

Inheritance

object > FeaturedContentNativeDashboardName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

FeaturedContentNativeDashboardName(string, string, string, string)

public FeaturedContentNativeDashboardName(string projectId, string locationId, string instanceId, string featuredContentNativeDashboardId)

Constructs a new instance of a FeaturedContentNativeDashboardName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_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.
featuredContentNativeDashboardId string

The FeaturedContentNativeDashboard ID. Must not be null or empty.

Properties

FeaturedContentNativeDashboardId

public string FeaturedContentNativeDashboardId { get; }

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

The FeaturedContentNativeDashboardName.ResourceNameType of the contained resource name.

Property Value
Type Description
FeaturedContentNativeDashboardNameResourceNameType

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

Formats the IDs into the string representation of this FeaturedContentNativeDashboardName with pattern projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_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.
featuredContentNativeDashboardId string

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

The string representation of this FeaturedContentNativeDashboardName with pattern projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_dashboard} .

FormatProjectLocationInstanceFeaturedContentNativeDashboard(string, string, string, string)

public static string FormatProjectLocationInstanceFeaturedContentNativeDashboard(string projectId, string locationId, string instanceId, string featuredContentNativeDashboardId)

Formats the IDs into the string representation of this FeaturedContentNativeDashboardName with pattern projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_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.
featuredContentNativeDashboardId string

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

The string representation of this FeaturedContentNativeDashboardName with pattern projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_dashboard} .

FromProjectLocationInstanceFeaturedContentNativeDashboard(string, string, string, string)

public static FeaturedContentNativeDashboardName FromProjectLocationInstanceFeaturedContentNativeDashboard(string projectId, string locationId, string instanceId, string featuredContentNativeDashboardId)

Creates a FeaturedContentNativeDashboardName with the pattern projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_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.
featuredContentNativeDashboardId string

The FeaturedContentNativeDashboard ID. Must not be null or empty.
Returns
Type Description
FeaturedContentNativeDashboardName

A new instance of FeaturedContentNativeDashboardName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FeaturedContentNativeDashboardName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FeaturedContentNativeDashboardName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
featuredContentNativeDashboardName string

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

The parsed FeaturedContentNativeDashboardName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_dashboard}

Parse(string, bool)

public static FeaturedContentNativeDashboardName Parse(string featuredContentNativeDashboardName, bool allowUnparsed)

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

Parameters
Name Description
featuredContentNativeDashboardName 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
FeaturedContentNativeDashboardName

The parsed FeaturedContentNativeDashboardName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_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 FeaturedContentNativeDashboardName)

public static bool TryParse(string featuredContentNativeDashboardName, out FeaturedContentNativeDashboardName result)

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

Parameters
Name Description
featuredContentNativeDashboardName string

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

When this method returns, the parsed FeaturedContentNativeDashboardName, 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}/contentHub/featuredContentNativeDashboards/{featured_content_native_dashboard}

TryParse(string, bool, out FeaturedContentNativeDashboardName)

public static bool TryParse(string featuredContentNativeDashboardName, bool allowUnparsed, out FeaturedContentNativeDashboardName result)

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

Parameters
Name Description
featuredContentNativeDashboardName 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 FeaturedContentNativeDashboardName

When this method returns, the parsed FeaturedContentNativeDashboardName, 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}/contentHub/featuredContentNativeDashboards/{featured_content_native_dashboard}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FeaturedContentNativeDashboardName, FeaturedContentNativeDashboardName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FeaturedContentNativeDashboardName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FeaturedContentNativeDashboardName

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

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.