Class RecommendationName (2.5.0)

public sealed class RecommendationName : IResourceName, IEquatable<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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

recommenderIdString

The Recommender ID. Must not be null or empty.

recommendationIdString

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
TypeDescription
String

FolderId

public string FolderId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

OrganizationId

public string OrganizationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

RecommendationId

public string RecommendationId { get; }

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

Property Value
TypeDescription
String

RecommenderId

public string RecommenderId { get; }

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

Property Value
TypeDescription
String

Type

public RecommendationName.ResourceNameType Type { get; }

The RecommendationName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
RecommendationName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

recommenderIdString

The Recommender ID. Must not be null or empty.

recommendationIdString

The Recommendation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
billingAccountIdString

The BillingAccount ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

recommenderIdString

The Recommender ID. Must not be null or empty.

recommendationIdString

The Recommendation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

recommenderIdString

The Recommender ID. Must not be null or empty.

recommendationIdString

The Recommendation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

recommenderIdString

The Recommender ID. Must not be null or empty.

recommendationIdString

The Recommendation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

recommenderIdString

The Recommender ID. Must not be null or empty.

recommendationIdString

The Recommendation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
billingAccountIdString

The BillingAccount ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

recommenderIdString

The Recommender ID. Must not be null or empty.

recommendationIdString

The Recommendation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

recommenderIdString

The Recommender ID. Must not be null or empty.

recommendationIdString

The Recommendation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

recommenderIdString

The Recommender ID. Must not be null or empty.

recommendationIdString

The Recommendation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

recommenderIdString

The Recommender ID. Must not be null or empty.

recommendationIdString

The Recommendation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
RecommendationName

A new instance of RecommendationName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static RecommendationName Parse(string recommendationName)

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

Parameter
NameDescription
recommendationNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
recommendationNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
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
NameDescription
recommendationNameString

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

resultRecommendationName

When this method returns, the parsed RecommendationName, or null if parsing failed.

Returns
TypeDescription
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}/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, Boolean, 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
NameDescription
recommendationNameString

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

allowUnparsedBoolean

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.

resultRecommendationName

When this method returns, the parsed RecommendationName, or null if parsing failed.

Returns
TypeDescription
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}/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

Equality(RecommendationName, RecommendationName)

public static bool operator ==(RecommendationName a, RecommendationName b)
Parameters
NameDescription
aRecommendationName
bRecommendationName
Returns
TypeDescription
Boolean

Inequality(RecommendationName, RecommendationName)

public static bool operator !=(RecommendationName a, RecommendationName b)
Parameters
NameDescription
aRecommendationName
bRecommendationName
Returns
TypeDescription
Boolean