Google Cloud Recommender v1 API - Class InsightTypeName (3.8.0) 

public sealed class InsightTypeName : IResourceName, IEquatable<InsightTypeName>

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

Resource name for the InsightType resource.

Inheritance

object > InsightTypeName

Namespace

Google.Cloud.Recommender.V1

Assembly

Google.Cloud.Recommender.V1.dll

Constructors

InsightTypeName(string, string, string)

public InsightTypeName(string projectId, string locationId, string insightTypeId)

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

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.

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

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

The InsightTypeName.ResourceNameType of the contained resource name.

Property Value
Type Description
InsightTypeNameResourceNameType

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

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

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.
Returns
Type Description
string

The string representation of this InsightTypeName with pattern projects/{project}/locations/{location}/insightTypes/{insight_type}.

FormatBillingAccountLocationInsightType(string, string, string)

public static string FormatBillingAccountLocationInsightType(string billingAccountId, string locationId, string insightTypeId)

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

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.
Returns
Type Description
string

The string representation of this InsightTypeName with pattern billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}.

FormatFolderLocationInsightType(string, string, string)

public static string FormatFolderLocationInsightType(string folderId, string locationId, string insightTypeId)

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

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.
Returns
Type Description
string

The string representation of this InsightTypeName with pattern folders/{folder}/locations/{location}/insightTypes/{insight_type}.

FormatOrganizationLocationInsightType(string, string, string)

public static string FormatOrganizationLocationInsightType(string organizationId, string locationId, string insightTypeId)

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

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.
Returns
Type Description
string

The string representation of this InsightTypeName with pattern organizations/{organization}/locations/{location}/insightTypes/{insight_type}.

FormatProjectLocationInsightType(string, string, string)

public static string FormatProjectLocationInsightType(string projectId, string locationId, string insightTypeId)

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

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.
Returns
Type Description
string

The string representation of this InsightTypeName with pattern projects/{project}/locations/{location}/insightTypes/{insight_type}.

FromBillingAccountLocationInsightType(string, string, string)

public static InsightTypeName FromBillingAccountLocationInsightType(string billingAccountId, string locationId, string insightTypeId)

Creates a InsightTypeName with the pattern billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}.

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.
Returns
Type Description
InsightTypeName

A new instance of InsightTypeName constructed from the provided ids.

FromFolderLocationInsightType(string, string, string)

public static InsightTypeName FromFolderLocationInsightType(string folderId, string locationId, string insightTypeId)

Creates a InsightTypeName with the pattern folders/{folder}/locations/{location}/insightTypes/{insight_type}.

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.
Returns
Type Description
InsightTypeName

A new instance of InsightTypeName constructed from the provided ids.

FromOrganizationLocationInsightType(string, string, string)

public static InsightTypeName FromOrganizationLocationInsightType(string organizationId, string locationId, string insightTypeId)

Creates a InsightTypeName with the pattern organizations/{organization}/locations/{location}/insightTypes/{insight_type}.

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.
Returns
Type Description
InsightTypeName

A new instance of InsightTypeName constructed from the provided ids.

FromProjectLocationInsightType(string, string, string)

public static InsightTypeName FromProjectLocationInsightType(string projectId, string locationId, string insightTypeId)

Creates a InsightTypeName with the pattern projects/{project}/locations/{location}/insightTypes/{insight_type}.

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.
Returns
Type Description
InsightTypeName

A new instance of InsightTypeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InsightTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InsightTypeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
insightTypeName string

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

The parsed InsightTypeName if successful.
Remarks

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

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

Parse(string, bool)

public static InsightTypeName Parse(string insightTypeName, bool allowUnparsed)

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

Parameters
Name Description
insightTypeName 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
InsightTypeName

The parsed InsightTypeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/insightTypes/{insight_type}
  • billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}
  • folders/{folder}/locations/{location}/insightTypes/{insight_type}
  • organizations/{organization}/locations/{location}/insightTypes/{insight_type}
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 InsightTypeName)

public static bool TryParse(string insightTypeName, out InsightTypeName result)

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

Parameters
Name Description
insightTypeName string

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

When this method returns, the parsed InsightTypeName, 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}
  • billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}
  • folders/{folder}/locations/{location}/insightTypes/{insight_type}
  • organizations/{organization}/locations/{location}/insightTypes/{insight_type}

TryParse(string, bool, out InsightTypeName)

public static bool TryParse(string insightTypeName, bool allowUnparsed, out InsightTypeName result)

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

Parameters
Name Description
insightTypeName 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 InsightTypeName

When this method returns, the parsed InsightTypeName, 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}
  • billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}
  • folders/{folder}/locations/{location}/insightTypes/{insight_type}
  • organizations/{organization}/locations/{location}/insightTypes/{insight_type}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(InsightTypeName, InsightTypeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a InsightTypeName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a InsightTypeName

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

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.