Class InsightTypeConfigName (3.1.0) 

public sealed class InsightTypeConfigName : IResourceName, IEquatable<InsightTypeConfigName>

Resource name for the InsightTypeConfig resource.

Inheritance

Object > InsightTypeConfigName

Namespace

Google.Cloud.Recommender.V1

Assembly

Google.Cloud.Recommender.V1.dll

Constructors

InsightTypeConfigName(String, String, String)

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

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

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

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
Boolean

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

The InsightTypeConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
InsightTypeConfigName.ResourceNameType

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 InsightTypeConfigName with pattern projects/{project}/locations/{location}/insightTypes/{insight_type}/config.

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 InsightTypeConfigName with pattern projects/{project}/locations/{location}/insightTypes/{insight_type}/config.

FormatOrganizationLocationInsightType(String, String, String)

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

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

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 InsightTypeConfigName with pattern organizations/{organization}/locations/{location}/insightTypes/{insight_type}/config.

FormatProjectLocationInsightType(String, String, String)

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

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

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 InsightTypeConfigName with pattern projects/{project}/locations/{location}/insightTypes/{insight_type}/config.

FromOrganizationLocationInsightType(String, String, String)

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

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

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
InsightTypeConfigName

A new instance of InsightTypeConfigName constructed from the provided ids.

FromProjectLocationInsightType(String, String, String)

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

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

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
InsightTypeConfigName

A new instance of InsightTypeConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InsightTypeConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InsightTypeConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of InsightTypeConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static InsightTypeConfigName Parse(string insightTypeConfigName)

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

Parameter
Name Description
insightTypeConfigName String

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

The parsed InsightTypeConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/insightTypes/{insight_type}/config
  • organizations/{organization}/locations/{location}/insightTypes/{insight_type}/config

Parse(String, Boolean)

public static InsightTypeConfigName Parse(string insightTypeConfigName, bool allowUnparsed)

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

Parameters
Name Description
insightTypeConfigName String

The resource name in string form. Must not be null.
allowUnparsed Boolean

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
InsightTypeConfigName

The parsed InsightTypeConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/insightTypes/{insight_type}/config
  • organizations/{organization}/locations/{location}/insightTypes/{insight_type}/config
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 InsightTypeConfigName)

public static bool TryParse(string insightTypeConfigName, out InsightTypeConfigName result)

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

Parameters
Name Description
insightTypeConfigName String

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

When this method returns, the parsed InsightTypeConfigName, or null if parsing failed.
Returns
Type Description
Boolean

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}/config
  • organizations/{organization}/locations/{location}/insightTypes/{insight_type}/config

TryParse(String, Boolean, out InsightTypeConfigName)

public static bool TryParse(string insightTypeConfigName, bool allowUnparsed, out InsightTypeConfigName result)

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

Parameters
Name Description
insightTypeConfigName String

The resource name in string form. Must not be null.
allowUnparsed Boolean

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 InsightTypeConfigName

When this method returns, the parsed InsightTypeConfigName, or null if parsing failed.
Returns
Type Description
Boolean

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}/config
  • organizations/{organization}/locations/{location}/insightTypes/{insight_type}/config
Or may be in any format if allowUnparsed is true.

Operators

Equality(InsightTypeConfigName, InsightTypeConfigName)

public static bool operator ==(InsightTypeConfigName a, InsightTypeConfigName b)
Parameters
Name Description
a InsightTypeConfigName
b InsightTypeConfigName
Returns
Type Description
Boolean

Inequality(InsightTypeConfigName, InsightTypeConfigName)

public static bool operator !=(InsightTypeConfigName a, InsightTypeConfigName b)
Parameters
Name Description
a InsightTypeConfigName
b InsightTypeConfigName
Returns
Type Description
Boolean