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.
Namespace
Google.Cloud.Recommender.V1Assembly
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 |
locationId | string The |
recommenderId | string The |
recommendationId | string The |
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 |
locationId | string The |
recommenderId | string The |
recommendationId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this RecommendationName with pattern
|
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 |
locationId | string The |
recommenderId | string The |
recommendationId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this RecommendationName with pattern
|
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 |
locationId | string The |
recommenderId | string The |
recommendationId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this RecommendationName with pattern
|
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 |
locationId | string The |
recommenderId | string The |
recommendationId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this RecommendationName with pattern
|
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 |
locationId | string The |
recommenderId | string The |
recommendationId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this RecommendationName with pattern
|
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 |
locationId | string The |
recommenderId | string The |
recommendationId | string The |
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 |
locationId | string The |
recommenderId | string The |
recommendationId | string The |
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 |
locationId | string The |
recommenderId | string The |
recommendationId | string The |
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 |
locationId | string The |
recommenderId | string The |
recommendationId | string The |
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 |
Returns | |
---|---|
Type | Description |
RecommendationName | A new instance of RecommendationName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
RecommendationName | The parsed RecommendationName if successful. |
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 |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
RecommendationName | The parsed RecommendationName if successful. |
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}
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. |
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 |
result | RecommendationName When this method returns, the parsed RecommendationName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 |
allowUnparsed | bool If |
result | RecommendationName When this method returns, the parsed RecommendationName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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}
allowUnparsed
is true
.
Operators
operator ==(RecommendationName, RecommendationName)
public static bool operator ==(RecommendationName a, RecommendationName b)
Parameters | |
---|---|
Name | Description |
a | RecommendationName |
b | RecommendationName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(RecommendationName, RecommendationName)
public static bool operator !=(RecommendationName a, RecommendationName b)
Parameters | |
---|---|
Name | Description |
a | RecommendationName |
b | RecommendationName |
Returns | |
---|---|
Type | Description |
bool |