Class EventStoreName (2.0.0-beta01)

public sealed class EventStoreName : IResourceName, IEquatable<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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

eventStoreIdString

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
TypeDescription
String

EventStoreId

public string EventStoreId { get; }

The EventStore ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

Type

public EventStoreName.ResourceNameType Type { get; }

The EventStoreName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
EventStoreName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

eventStoreIdString

The EventStore ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

eventStoreIdString

The EventStore ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

eventStoreIdString

The EventStore ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
EventStoreName

A new instance of EventStoreName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static EventStoreName Parse(string eventStoreName)

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

Parameter
NameDescription
eventStoreNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
eventStoreNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
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
NameDescription
eventStoreNameString

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

resultEventStoreName

When this method returns, the parsed EventStoreName, or null if parsing failed.

Returns
TypeDescription
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}/catalogs/{catalog}/eventStores/{event_store}

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

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

allowUnparsedBoolean

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.

resultEventStoreName

When this method returns, the parsed EventStoreName, or null if parsing failed.

Returns
TypeDescription
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}/catalogs/{catalog}/eventStores/{event_store}
Or may be in any format if allowUnparsed is true.

Operators

Equality(EventStoreName, EventStoreName)

public static bool operator ==(EventStoreName a, EventStoreName b)
Parameters
NameDescription
aEventStoreName
bEventStoreName
Returns
TypeDescription
Boolean

Inequality(EventStoreName, EventStoreName)

public static bool operator !=(EventStoreName a, EventStoreName b)
Parameters
NameDescription
aEventStoreName
bEventStoreName
Returns
TypeDescription
Boolean