Google Cloud Recommender v1 API - Class RecommendationName (3.6.0) 

public sealed class RecommendationName : IResourceName, IEquatable<RecommendationName>

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

Resource name for the Recommendation resource.

Inheritance

object > RecommendationName

Namespace

Google.Cloud.Recommender.V1

Assembly

Google.Cloud.Recommender.V1.dll

Constructors

RecommendationName(string, string, string, string)

public RecommendationName(string projectId, string locationId, string recommenderId, string recommendationId)

Constructs a new instance of a RecommendationName class from the component parts of pattern projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}

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.
recommendationId string

The Recommendation 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

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

RecommendationId

public string RecommendationId { get; }

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

The RecommendationName.ResourceNameType of the contained resource name.

Property Value
Type Description
RecommendationNameResourceNameType

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 recommenderId, string recommendationId)

Formats the IDs into the string representation of this RecommendationName with pattern projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}.

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.
recommendationId string

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

The string representation of this RecommendationName with pattern projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}.

FormatBillingAccountLocationRecommenderRecommendation(string, string, string, string)

public static string FormatBillingAccountLocationRecommenderRecommendation(string billingAccountId, string locationId, string recommenderId, string recommendationId)

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

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.
recommendationId string

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

The string representation of this RecommendationName with pattern billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation} .

FormatFolderLocationRecommenderRecommendation(string, string, string, string)

public static string FormatFolderLocationRecommenderRecommendation(string folderId, string locationId, string recommenderId, string recommendationId)

Formats the IDs into the string representation of this RecommendationName with pattern folders/{folder}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}.

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.
recommenderId string

The Recommender ID. Must not be null or empty.
recommendationId string

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

The string representation of this RecommendationName with pattern folders/{folder}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}.

FormatOrganizationLocationRecommenderRecommendation(string, string, string, string)

public static string FormatOrganizationLocationRecommenderRecommendation(string organizationId, string locationId, string recommenderId, string recommendationId)

Formats the IDs into the string representation of this RecommendationName with pattern organizations/{organization}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation} .

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.
recommendationId string

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

The string representation of this RecommendationName with pattern organizations/{organization}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation} .

FormatProjectLocationRecommenderRecommendation(string, string, string, string)

public static string FormatProjectLocationRecommenderRecommendation(string projectId, string locationId, string recommenderId, string recommendationId)

Formats the IDs into the string representation of this RecommendationName with pattern projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}.

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.
recommendationId string

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

The string representation of this RecommendationName with pattern projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}.

FromBillingAccountLocationRecommenderRecommendation(string, string, string, string)

public static RecommendationName FromBillingAccountLocationRecommenderRecommendation(string billingAccountId, string locationId, string recommenderId, string recommendationId)

Creates a RecommendationName with the pattern billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation} .

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.
recommendationId string

The Recommendation ID. Must not be null or empty.
Returns
Type Description
RecommendationName

A new instance of RecommendationName constructed from the provided ids.

FromFolderLocationRecommenderRecommendation(string, string, string, string)

public static RecommendationName FromFolderLocationRecommenderRecommendation(string folderId, string locationId, string recommenderId, string recommendationId)

Creates a RecommendationName with the pattern folders/{folder}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}.

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.
recommenderId string

The Recommender ID. Must not be null or empty.
recommendationId string

The Recommendation ID. Must not be null or empty.
Returns
Type Description
RecommendationName

A new instance of RecommendationName constructed from the provided ids.

FromOrganizationLocationRecommenderRecommendation(string, string, string, string)

public static RecommendationName FromOrganizationLocationRecommenderRecommendation(string organizationId, string locationId, string recommenderId, string recommendationId)

Creates a RecommendationName with the pattern organizations/{organization}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation} .

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.
recommendationId string

The Recommendation ID. Must not be null or empty.
Returns
Type Description
RecommendationName

A new instance of RecommendationName constructed from the provided ids.

FromProjectLocationRecommenderRecommendation(string, string, string, string)

public static RecommendationName FromProjectLocationRecommenderRecommendation(string projectId, string locationId, string recommenderId, string recommendationId)

Creates a RecommendationName with the pattern projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}.

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.
recommendationId string

The Recommendation ID. Must not be null or empty.
Returns
Type Description
RecommendationName

A new instance of RecommendationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RecommendationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RecommendationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
recommendationName string

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

The parsed RecommendationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
  • billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
  • folders/{folder}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
  • organizations/{organization}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}

Parse(string, bool)

public static RecommendationName Parse(string recommendationName, bool allowUnparsed)

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

Parameters
Name Description
recommendationName 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
RecommendationName

The parsed RecommendationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
  • billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
  • folders/{folder}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
  • organizations/{organization}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
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 RecommendationName)

public static bool TryParse(string recommendationName, out RecommendationName result)

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

Parameters
Name Description
recommendationName string

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

When this method returns, the parsed RecommendationName, 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}/recommendations/{recommendation}
  • billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
  • folders/{folder}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
  • organizations/{organization}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}

TryParse(string, bool, out RecommendationName)

public static bool TryParse(string recommendationName, bool allowUnparsed, out RecommendationName result)

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

Parameters
Name Description
recommendationName 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 RecommendationName

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

Operators

operator ==(RecommendationName, RecommendationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RecommendationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RecommendationName

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

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.