Google Cloud Recommender v1 API - Class RecommenderConfigName (3.6.0)

public sealed class RecommenderConfigName : IResourceName, IEquatable<RecommenderConfigName>

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

Resource name for the RecommenderConfig resource.

Inheritance

object > RecommenderConfigName

Implements

IResourceName, IEquatable RecommenderConfigName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Recommender.V1

Assembly

Google.Cloud.Recommender.V1.dll

Constructors

RecommenderConfigName(string, string, string)

public RecommenderConfigName(string projectId, string locationId, string recommenderId)

Constructs a new instance of a RecommenderConfigName class from the component parts of pattern projects/{project}/locations/{location}/recommenders/{recommender}/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.
`recommenderId`	`string` The `Recommender` 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`

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`

RecommenderId

public string RecommenderId { get; }

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

Property Value
Type	Description
`string`

Type

public RecommenderConfigName.ResourceNameType Type { get; }

The RecommenderConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`RecommenderConfigNameResourceNameType`

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

Formats the IDs into the string representation of this RecommenderConfigName with pattern projects/{project}/locations/{location}/recommenders/{recommender}/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.
`recommenderId`	`string` The `Recommender` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this RecommenderConfigName with pattern `projects/{project}/locations/{location}/recommenders/{recommender}/config`.

FormatBillingAccountLocationRecommender(string, string, string)

public static string FormatBillingAccountLocationRecommender(string billingAccountId, string locationId, string recommenderId)

Formats the IDs into the string representation of this RecommenderConfigName with pattern billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/config.

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.
`recommenderId`	`string` The `Recommender` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this RecommenderConfigName with pattern `billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/config`.

FormatOrganizationLocationRecommender(string, string, string)

public static string FormatOrganizationLocationRecommender(string organizationId, string locationId, string recommenderId)

Formats the IDs into the string representation of this RecommenderConfigName with pattern organizations/{organization}/locations/{location}/recommenders/{recommender}/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.
`recommenderId`	`string` The `Recommender` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this RecommenderConfigName with pattern `organizations/{organization}/locations/{location}/recommenders/{recommender}/config`.

FormatProjectLocationRecommender(string, string, string)

public static string FormatProjectLocationRecommender(string projectId, string locationId, string recommenderId)

Formats the IDs into the string representation of this RecommenderConfigName with pattern projects/{project}/locations/{location}/recommenders/{recommender}/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.
`recommenderId`	`string` The `Recommender` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this RecommenderConfigName with pattern `projects/{project}/locations/{location}/recommenders/{recommender}/config`.

FromBillingAccountLocationRecommender(string, string, string)

public static RecommenderConfigName FromBillingAccountLocationRecommender(string billingAccountId, string locationId, string recommenderId)

Creates a RecommenderConfigName with the pattern billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/config.

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.
`recommenderId`	`string` The `Recommender` ID. Must not be `null` or empty.

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

FromOrganizationLocationRecommender(string, string, string)

public static RecommenderConfigName FromOrganizationLocationRecommender(string organizationId, string locationId, string recommenderId)

Creates a RecommenderConfigName with the pattern organizations/{organization}/locations/{location}/recommenders/{recommender}/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.
`recommenderId`	`string` The `Recommender` ID. Must not be `null` or empty.

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

FromProjectLocationRecommender(string, string, string)

public static RecommenderConfigName FromProjectLocationRecommender(string projectId, string locationId, string recommenderId)

Creates a RecommenderConfigName with the pattern projects/{project}/locations/{location}/recommenders/{recommender}/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.
`recommenderId`	`string` The `Recommender` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static RecommenderConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RecommenderConfigName containing an unparsed resource name.

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

Returns
Type	Description
`RecommenderConfigName`	A new instance of RecommenderConfigName 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 RecommenderConfigName Parse(string recommenderConfigName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/recommenders/{recommender}/config
organizations/{organization}/locations/{location}/recommenders/{recommender}/config
billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/config

Parse(string, bool)

public static RecommenderConfigName Parse(string recommenderConfigName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/recommenders/{recommender}/config
organizations/{organization}/locations/{location}/recommenders/{recommender}/config
billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/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

object.ToString()

TryParse(string, out RecommenderConfigName)

public static bool TryParse(string recommenderConfigName, out RecommenderConfigName result)

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

Parameters
Name	Description
`recommenderConfigName`	`string` The resource name in string form. Must not be `null`.
`result`	`RecommenderConfigName` When this method returns, the parsed RecommenderConfigName, 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}/recommenders/{recommender}/config
organizations/{organization}/locations/{location}/recommenders/{recommender}/config
billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/config

TryParse(string, bool, out RecommenderConfigName)

public static bool TryParse(string recommenderConfigName, bool allowUnparsed, out RecommenderConfigName result)

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

Parameters
Name	Description
`recommenderConfigName`	`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`	`RecommenderConfigName` When this method returns, the parsed RecommenderConfigName, 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}/recommenders/{recommender}/config
organizations/{organization}/locations/{location}/recommenders/{recommender}/config
billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/config

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RecommenderConfigName, RecommenderConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`RecommenderConfigName` The first resource name to compare, or null.
`b`	`RecommenderConfigName` 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 !=(RecommenderConfigName, RecommenderConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`RecommenderConfigName` The first resource name to compare, or null.
`b`	`RecommenderConfigName` 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.