Class RecommenderConfigName (3.1.0) 

public sealed class RecommenderConfigName : IResourceName, IEquatable<RecommenderConfigName>

Resource name for the RecommenderConfig resource.

Inheritance

Object > RecommenderConfigName

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

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
Boolean

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
RecommenderConfigName.ResourceNameType

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.

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.

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
Int32
Overrides

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

Parse(String, Boolean)

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 Boolean

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
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 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
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}/config
  • organizations/{organization}/locations/{location}/recommenders/{recommender}/config

TryParse(String, Boolean, 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 Boolean

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
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}/config
  • organizations/{organization}/locations/{location}/recommenders/{recommender}/config
Or may be in any format if allowUnparsed is true.

Operators

Equality(RecommenderConfigName, RecommenderConfigName)

public static bool operator ==(RecommenderConfigName a, RecommenderConfigName b)
Parameters
Name Description
a RecommenderConfigName
b RecommenderConfigName
Returns
Type Description
Boolean

Inequality(RecommenderConfigName, RecommenderConfigName)

public static bool operator !=(RecommenderConfigName a, RecommenderConfigName b)
Parameters
Name Description
a RecommenderConfigName
b RecommenderConfigName
Returns
Type Description
Boolean