Recommendations AI v1beta1 API - Class EventStoreName (2.0.0-beta06) 

public sealed class EventStoreName : IResourceName, IEquatable<EventStoreName>

Reference documentation and code samples for the Recommendations AI v1beta1 API class EventStoreName.

Resource name for the EventStore resource.

Inheritance

object > EventStoreName

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

EventStoreName(string, string, string, string)

public EventStoreName(string projectId, string locationId, string catalogId, string eventStoreId)

Constructs a new instance of a EventStoreName class from the component parts of pattern projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}

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.
catalogId string

The Catalog ID. Must not be null or empty.
eventStoreId string

The EventStore ID. Must not be null or empty.

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

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

The EventStoreName.ResourceNameType of the contained resource name.

Property Value
Type Description
EventStoreNameResourceNameType

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 catalogId, string eventStoreId)

Formats the IDs into the string representation of this EventStoreName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}.

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.
catalogId string

The Catalog ID. Must not be null or empty.
eventStoreId string

The EventStore ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this EventStoreName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}.

FormatProjectLocationCatalogEventStore(string, string, string, string)

public static string FormatProjectLocationCatalogEventStore(string projectId, string locationId, string catalogId, string eventStoreId)

Formats the IDs into the string representation of this EventStoreName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}.

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.
catalogId string

The Catalog ID. Must not be null or empty.
eventStoreId string

The EventStore ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this EventStoreName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}.

FromProjectLocationCatalogEventStore(string, string, string, string)

public static EventStoreName FromProjectLocationCatalogEventStore(string projectId, string locationId, string catalogId, string eventStoreId)

Creates a EventStoreName with the pattern projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}.

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.
catalogId string

The Catalog ID. Must not be null or empty.
eventStoreId string

The EventStore ID. Must not be null or empty.
Returns
Type Description
EventStoreName

A new instance of EventStoreName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EventStoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EventStoreName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
eventStoreName string

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

The parsed EventStoreName if successful.
Remarks

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

  • projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}

Parse(string, bool)

public static EventStoreName Parse(string eventStoreName, bool allowUnparsed)

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

Parameters
Name Description
eventStoreName 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
EventStoreName

The parsed EventStoreName if successful.
Remarks

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

  • projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}
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 EventStoreName)

public static bool TryParse(string eventStoreName, out EventStoreName result)

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

Parameters
Name Description
eventStoreName string

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

When this method returns, the parsed EventStoreName, 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}/catalogs/{catalog}/eventStores/{event_store}

TryParse(string, bool, out EventStoreName)

public static bool TryParse(string eventStoreName, bool allowUnparsed, out EventStoreName result)

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

Parameters
Name Description
eventStoreName 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 EventStoreName

When this method returns, the parsed EventStoreName, 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}/catalogs/{catalog}/eventStores/{event_store}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EventStoreName, EventStoreName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EventStoreName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EventStoreName

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

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.