Google Cloud Recommender v1 API - Class RecommenderName (3.6.0) 

public sealed class RecommenderName : IResourceName, IEquatable<RecommenderName>

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

Resource name for the Recommender resource.

Inheritance

object > RecommenderName

Namespace

Google.Cloud.Recommender.V1

Assembly

Google.Cloud.Recommender.V1.dll

Constructors

RecommenderName(string, string, string)

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

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

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

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

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

The RecommenderName.ResourceNameType of the contained resource name.

Property Value
Type Description
RecommenderNameResourceNameType

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 RecommenderName with pattern projects/{project}/locations/{location}/recommenders/{recommender}.

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 RecommenderName with pattern projects/{project}/locations/{location}/recommenders/{recommender}.

FormatBillingAccountLocationRecommender(string, string, string)

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

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

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 RecommenderName with pattern billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}.

FormatFolderLocationRecommender(string, string, string)

public static string FormatFolderLocationRecommender(string folderId, string locationId, string recommenderId)

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

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

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

FormatOrganizationLocationRecommender(string, string, string)

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

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

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 RecommenderName with pattern organizations/{organization}/locations/{location}/recommenders/{recommender}.

FormatProjectLocationRecommender(string, string, string)

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

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

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 RecommenderName with pattern projects/{project}/locations/{location}/recommenders/{recommender}.

FromBillingAccountLocationRecommender(string, string, string)

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

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

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
RecommenderName

A new instance of RecommenderName constructed from the provided ids.

FromFolderLocationRecommender(string, string, string)

public static RecommenderName FromFolderLocationRecommender(string folderId, string locationId, string recommenderId)

Creates a RecommenderName with the pattern folders/{folder}/locations/{location}/recommenders/{recommender}.

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

A new instance of RecommenderName constructed from the provided ids.

FromOrganizationLocationRecommender(string, string, string)

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

Creates a RecommenderName with the pattern organizations/{organization}/locations/{location}/recommenders/{recommender}.

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
RecommenderName

A new instance of RecommenderName constructed from the provided ids.

FromProjectLocationRecommender(string, string, string)

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

Creates a RecommenderName with the pattern projects/{project}/locations/{location}/recommenders/{recommender}.

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
RecommenderName

A new instance of RecommenderName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RecommenderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RecommenderName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
recommenderName string

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

The parsed RecommenderName if successful.
Remarks

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

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

Parse(string, bool)

public static RecommenderName Parse(string recommenderName, bool allowUnparsed)

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

Parameters
Name Description
recommenderName 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
RecommenderName

The parsed RecommenderName if successful.
Remarks

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

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

public static bool TryParse(string recommenderName, out RecommenderName result)

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

Parameters
Name Description
recommenderName string

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

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

TryParse(string, bool, out RecommenderName)

public static bool TryParse(string recommenderName, bool allowUnparsed, out RecommenderName result)

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

Parameters
Name Description
recommenderName 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 RecommenderName

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

Operators

operator ==(RecommenderName, RecommenderName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RecommenderName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RecommenderName

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

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.