Google Cloud Recommender v1 API - Class InsightName (3.3.0)

public sealed class InsightName : IResourceName, IEquatable<InsightName>

Reference documentation and code samples for the Google Cloud Recommender v1 API class InsightName.

Resource name for the Insight resource.

Inheritance

object > InsightName

Implements

IResourceName, IEquatable InsightName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Recommender.V1

Assembly

Google.Cloud.Recommender.V1.dll

Constructors

InsightName(string, string, string, string)

public InsightName(string projectId, string locationId, string insightTypeId, string insightId)

Constructs a new instance of a InsightName class from the component parts of pattern projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}

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.
`insightTypeId`	`string` The `InsightType` ID. Must not be `null` or empty.
`insightId`	`string` The `Insight` ID. Must not be `null` or empty.

Properties

BillingAccountId

public string BillingAccountId { get; }

The BillingAccount ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

InsightId

public string InsightId { get; }

The Insight ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

InsightTypeId

public string InsightTypeId { get; }

The InsightType ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public InsightName.ResourceNameType Type { get; }

The InsightName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`InsightNameResourceNameType`

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 insightTypeId, string insightId)

Formats the IDs into the string representation of this InsightName with pattern projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}.

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.
`insightTypeId`	`string` The `InsightType` ID. Must not be `null` or empty.
`insightId`	`string` The `Insight` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this InsightName with pattern `projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`.

FormatBillingAccountLocationInsightTypeInsight(string, string, string, string)

public static string FormatBillingAccountLocationInsightTypeInsight(string billingAccountId, string locationId, string insightTypeId, string insightId)

Formats the IDs into the string representation of this InsightName with pattern billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/insights/{insight} .

Parameters
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`insightTypeId`	`string` The `InsightType` ID. Must not be `null` or empty.
`insightId`	`string` The `Insight` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this InsightName with pattern `billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/insights/{insight}` .

FormatFolderLocationInsightTypeInsight(string, string, string, string)

public static string FormatFolderLocationInsightTypeInsight(string folderId, string locationId, string insightTypeId, string insightId)

Formats the IDs into the string representation of this InsightName with pattern folders/{folder}/locations/{location}/insightTypes/{insight_type}/insights/{insight}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`insightTypeId`	`string` The `InsightType` ID. Must not be `null` or empty.
`insightId`	`string` The `Insight` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this InsightName with pattern `folders/{folder}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`.

FormatOrganizationLocationInsightTypeInsight(string, string, string, string)

public static string FormatOrganizationLocationInsightTypeInsight(string organizationId, string locationId, string insightTypeId, string insightId)

Formats the IDs into the string representation of this InsightName with pattern organizations/{organization}/locations/{location}/insightTypes/{insight_type}/insights/{insight}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`insightTypeId`	`string` The `InsightType` ID. Must not be `null` or empty.
`insightId`	`string` The `Insight` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this InsightName with pattern `organizations/{organization}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`.

FormatProjectLocationInsightTypeInsight(string, string, string, string)

public static string FormatProjectLocationInsightTypeInsight(string projectId, string locationId, string insightTypeId, string insightId)

Formats the IDs into the string representation of this InsightName with pattern projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}.

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.
`insightTypeId`	`string` The `InsightType` ID. Must not be `null` or empty.
`insightId`	`string` The `Insight` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this InsightName with pattern `projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`.

FromBillingAccountLocationInsightTypeInsight(string, string, string, string)

public static InsightName FromBillingAccountLocationInsightTypeInsight(string billingAccountId, string locationId, string insightTypeId, string insightId)

Creates a InsightName with the pattern billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/insights/{insight} .

Parameters
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`insightTypeId`	`string` The `InsightType` ID. Must not be `null` or empty.
`insightId`	`string` The `Insight` ID. Must not be `null` or empty.

Returns
Type	Description
`InsightName`	A new instance of InsightName constructed from the provided ids.

FromFolderLocationInsightTypeInsight(string, string, string, string)

public static InsightName FromFolderLocationInsightTypeInsight(string folderId, string locationId, string insightTypeId, string insightId)

Creates a InsightName with the pattern folders/{folder}/locations/{location}/insightTypes/{insight_type}/insights/{insight}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`insightTypeId`	`string` The `InsightType` ID. Must not be `null` or empty.
`insightId`	`string` The `Insight` ID. Must not be `null` or empty.

Returns
Type	Description
`InsightName`	A new instance of InsightName constructed from the provided ids.

FromOrganizationLocationInsightTypeInsight(string, string, string, string)

public static InsightName FromOrganizationLocationInsightTypeInsight(string organizationId, string locationId, string insightTypeId, string insightId)

Creates a InsightName with the pattern organizations/{organization}/locations/{location}/insightTypes/{insight_type}/insights/{insight}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`insightTypeId`	`string` The `InsightType` ID. Must not be `null` or empty.
`insightId`	`string` The `Insight` ID. Must not be `null` or empty.

Returns
Type	Description
`InsightName`	A new instance of InsightName constructed from the provided ids.

FromProjectLocationInsightTypeInsight(string, string, string, string)

public static InsightName FromProjectLocationInsightTypeInsight(string projectId, string locationId, string insightTypeId, string insightId)

Creates a InsightName with the pattern projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}.

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.
`insightTypeId`	`string` The `InsightType` ID. Must not be `null` or empty.
`insightId`	`string` The `Insight` ID. Must not be `null` or empty.

Returns
Type	Description
`InsightName`	A new instance of InsightName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InsightName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InsightName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`InsightName`	A new instance of InsightName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static InsightName Parse(string insightName)

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

Parameter
Name	Description
`insightName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`InsightName`	The parsed InsightName if successful.

Remarks

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

projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
folders/{folder}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
organizations/{organization}/locations/{location}/insightTypes/{insight_type}/insights/{insight}

Parse(string, bool)

public static InsightName Parse(string insightName, bool allowUnparsed)

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

Parameters
Name	Description
`insightName`	`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
`InsightName`	The parsed InsightName if successful.

Remarks

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

projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
folders/{folder}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
organizations/{organization}/locations/{location}/insightTypes/{insight_type}/insights/{insight}

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

object.ToString()

TryParse(string, out InsightName)

public static bool TryParse(string insightName, out InsightName result)

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

Parameters
Name	Description
`insightName`	`string` The resource name in string form. Must not be `null`.
`result`	`InsightName` When this method returns, the parsed InsightName, 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}/insightTypes/{insight_type}/insights/{insight}
billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
folders/{folder}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
organizations/{organization}/locations/{location}/insightTypes/{insight_type}/insights/{insight}

TryParse(string, bool, out InsightName)

public static bool TryParse(string insightName, bool allowUnparsed, out InsightName result)

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

Parameters
Name	Description
`insightName`	`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`	`InsightName` When this method returns, the parsed InsightName, 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}/insightTypes/{insight_type}/insights/{insight}
billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
folders/{folder}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
organizations/{organization}/locations/{location}/insightTypes/{insight_type}/insights/{insight}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(InsightName, InsightName)

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

Parameters
Name	Description
`a`	`InsightName`
`b`	`InsightName`

Returns
Type	Description
`bool`

operator !=(InsightName, InsightName)

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

Parameters
Name	Description
`a`	`InsightName`
`b`	`InsightName`

Returns
Type	Description
`bool`