Vertex AI v1beta1 API - Class SessionEventName (1.0.0-beta24) 

public sealed class SessionEventName : IResourceName, IEquatable<SessionEventName>

Reference documentation and code samples for the Vertex AI v1beta1 API class SessionEventName.

Resource name for the SessionEvent resource.

Inheritance

object > SessionEventName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

SessionEventName(string, string, string, string)

public SessionEventName(string projectId, string locationId, string sessionId, string eventId)

Constructs a new instance of a SessionEventName class from the component parts of pattern projects/{project}/locations/{location}/sessions/{session}/events/{event}

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

The Session ID. Must not be null or empty.
eventId string

The Event ID. Must not be null or empty.

Properties

EventId

public string EventId { get; }

The Event 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

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

ReasoningEngineId

public string ReasoningEngineId { get; }

The ReasoningEngine ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

SessionId

public string SessionId { get; }

The Session ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public SessionEventName.ResourceNameType Type { get; }

The SessionEventName.ResourceNameType of the contained resource name.

Property Value
Type Description
SessionEventNameResourceNameType

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 sessionId, string eventId)

Formats the IDs into the string representation of this SessionEventName with pattern projects/{project}/locations/{location}/sessions/{session}/events/{event}.

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

The Session ID. Must not be null or empty.
eventId string

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

The string representation of this SessionEventName with pattern projects/{project}/locations/{location}/sessions/{session}/events/{event}.

FormatProjectLocationReasoningEngineSessionEvent(string, string, string, string, string)

public static string FormatProjectLocationReasoningEngineSessionEvent(string projectId, string locationId, string reasoningEngineId, string sessionId, string eventId)

Formats the IDs into the string representation of this SessionEventName with pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event} .

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

The ReasoningEngine ID. Must not be null or empty.
sessionId string

The Session ID. Must not be null or empty.
eventId string

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

The string representation of this SessionEventName with pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event} .

FormatProjectLocationSessionEvent(string, string, string, string)

public static string FormatProjectLocationSessionEvent(string projectId, string locationId, string sessionId, string eventId)

Formats the IDs into the string representation of this SessionEventName with pattern projects/{project}/locations/{location}/sessions/{session}/events/{event}.

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

The Session ID. Must not be null or empty.
eventId string

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

The string representation of this SessionEventName with pattern projects/{project}/locations/{location}/sessions/{session}/events/{event}.

FromProjectLocationReasoningEngineSessionEvent(string, string, string, string, string)

public static SessionEventName FromProjectLocationReasoningEngineSessionEvent(string projectId, string locationId, string reasoningEngineId, string sessionId, string eventId)

Creates a SessionEventName with the pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event} .

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

The ReasoningEngine ID. Must not be null or empty.
sessionId string

The Session ID. Must not be null or empty.
eventId string

The Event ID. Must not be null or empty.
Returns
Type Description
SessionEventName

A new instance of SessionEventName constructed from the provided ids.

FromProjectLocationSessionEvent(string, string, string, string)

public static SessionEventName FromProjectLocationSessionEvent(string projectId, string locationId, string sessionId, string eventId)

Creates a SessionEventName with the pattern projects/{project}/locations/{location}/sessions/{session}/events/{event}.

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

The Session ID. Must not be null or empty.
eventId string

The Event ID. Must not be null or empty.
Returns
Type Description
SessionEventName

A new instance of SessionEventName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SessionEventName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SessionEventName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
sessionEventName string

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

The parsed SessionEventName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sessions/{session}/events/{event}
  • projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}

Parse(string, bool)

public static SessionEventName Parse(string sessionEventName, bool allowUnparsed)

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

Parameters
Name Description
sessionEventName 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
SessionEventName

The parsed SessionEventName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sessions/{session}/events/{event}
  • projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}
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 SessionEventName)

public static bool TryParse(string sessionEventName, out SessionEventName result)

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

Parameters
Name Description
sessionEventName string

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

When this method returns, the parsed SessionEventName, 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}/sessions/{session}/events/{event}
  • projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}

TryParse(string, bool, out SessionEventName)

public static bool TryParse(string sessionEventName, bool allowUnparsed, out SessionEventName result)

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

Parameters
Name Description
sessionEventName 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 SessionEventName

When this method returns, the parsed SessionEventName, 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}/sessions/{session}/events/{event}
  • projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SessionEventName, SessionEventName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SessionEventName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SessionEventName

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

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.