public sealed class PredictionApiKeyRegistrationName : IResourceName, IEquatable<PredictionApiKeyRegistrationName>
Reference documentation and code samples for the Recommendations AI v1beta1 API class PredictionApiKeyRegistrationName.
Resource name for the PredictionApiKeyRegistration
resource.
Namespace
Google.Cloud.RecommendationEngine.V1Beta1Assembly
Google.Cloud.RecommendationEngine.V1Beta1.dll
Constructors
PredictionApiKeyRegistrationName(string, string, string, string, string)
public PredictionApiKeyRegistrationName(string projectId, string locationId, string catalogId, string eventStoreId, string predictionApiKeyRegistrationId)
Constructs a new instance of a PredictionApiKeyRegistrationName class from the component parts
of pattern
projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
catalogId |
string The |
eventStoreId |
string The |
predictionApiKeyRegistrationId |
string The |
Properties
CatalogId
public string CatalogId { get; }
The Catalog
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
EventStoreId
public string EventStoreId { get; }
The EventStore
ID. Will not be null
, unless this instance contains an unparsed resource name.
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. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
PredictionApiKeyRegistrationId
public string PredictionApiKeyRegistrationId { get; }
The PredictionApiKeyRegistration
ID. Will not be null
, unless this instance contains an
unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
ProjectId
public string ProjectId { get; }
The Project
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Type
public PredictionApiKeyRegistrationName.ResourceNameType Type { get; }
The PredictionApiKeyRegistrationName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
PredictionApiKeyRegistrationNameResourceNameType |
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, string)
public static string Format(string projectId, string locationId, string catalogId, string eventStoreId, string predictionApiKeyRegistrationId)
Formats the IDs into the string representation of this PredictionApiKeyRegistrationName with
pattern
projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
catalogId |
string The |
eventStoreId |
string The |
predictionApiKeyRegistrationId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this PredictionApiKeyRegistrationName with pattern
|
FormatProjectLocationCatalogEventStorePredictionApiKeyRegistration(string, string, string, string, string)
public static string FormatProjectLocationCatalogEventStorePredictionApiKeyRegistration(string projectId, string locationId, string catalogId, string eventStoreId, string predictionApiKeyRegistrationId)
Formats the IDs into the string representation of this PredictionApiKeyRegistrationName with
pattern
projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
catalogId |
string The |
eventStoreId |
string The |
predictionApiKeyRegistrationId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this PredictionApiKeyRegistrationName with pattern
|
FromProjectLocationCatalogEventStorePredictionApiKeyRegistration(string, string, string, string, string)
public static PredictionApiKeyRegistrationName FromProjectLocationCatalogEventStorePredictionApiKeyRegistration(string projectId, string locationId, string catalogId, string eventStoreId, string predictionApiKeyRegistrationId)
Creates a PredictionApiKeyRegistrationName with the pattern
projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
catalogId |
string The |
eventStoreId |
string The |
predictionApiKeyRegistrationId |
string The |
Returns | |
---|---|
Type | Description |
PredictionApiKeyRegistrationName |
A new instance of PredictionApiKeyRegistrationName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static PredictionApiKeyRegistrationName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a PredictionApiKeyRegistrationName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
PredictionApiKeyRegistrationName |
A new instance of PredictionApiKeyRegistrationName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static PredictionApiKeyRegistrationName Parse(string predictionApiKeyRegistrationName)
Parses the given resource name string into a new PredictionApiKeyRegistrationName instance.
Parameter | |
---|---|
Name | Description |
predictionApiKeyRegistrationName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
PredictionApiKeyRegistrationName |
The parsed PredictionApiKeyRegistrationName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}
Parse(string, bool)
public static PredictionApiKeyRegistrationName Parse(string predictionApiKeyRegistrationName, bool allowUnparsed)
Parses the given resource name string into a new PredictionApiKeyRegistrationName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
predictionApiKeyRegistrationName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
PredictionApiKeyRegistrationName |
The parsed PredictionApiKeyRegistrationName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}
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 PredictionApiKeyRegistrationName)
public static bool TryParse(string predictionApiKeyRegistrationName, out PredictionApiKeyRegistrationName result)
Tries to parse the given resource name string into a new PredictionApiKeyRegistrationName instance.
Parameters | |
---|---|
Name | Description |
predictionApiKeyRegistrationName |
string The resource name in string form. Must not be |
result |
PredictionApiKeyRegistrationName When this method returns, the parsed PredictionApiKeyRegistrationName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}
TryParse(string, bool, out PredictionApiKeyRegistrationName)
public static bool TryParse(string predictionApiKeyRegistrationName, bool allowUnparsed, out PredictionApiKeyRegistrationName result)
Tries to parse the given resource name string into a new PredictionApiKeyRegistrationName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
predictionApiKeyRegistrationName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
PredictionApiKeyRegistrationName When this method returns, the parsed PredictionApiKeyRegistrationName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}
allowUnparsed
is true
.
Operators
operator ==(PredictionApiKeyRegistrationName, PredictionApiKeyRegistrationName)
public static bool operator ==(PredictionApiKeyRegistrationName a, PredictionApiKeyRegistrationName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
PredictionApiKeyRegistrationName The first resource name to compare, or null. |
b |
PredictionApiKeyRegistrationName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(PredictionApiKeyRegistrationName, PredictionApiKeyRegistrationName)
public static bool operator !=(PredictionApiKeyRegistrationName a, PredictionApiKeyRegistrationName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
PredictionApiKeyRegistrationName The first resource name to compare, or null. |
b |
PredictionApiKeyRegistrationName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |