Vertex AI v1beta1 API - Class MemoryName (1.0.0-beta61) 

public sealed class MemoryName : IResourceName, IEquatable<MemoryName>

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

Resource name for the Memory resource.

Inheritance

object > MemoryName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

MemoryName(string, string, string, string)

public MemoryName(string projectId, string locationId, string reasoningEngineId, string memoryId)

Constructs a new instance of a MemoryName class from the component parts of pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}

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

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

MemoryId

public string MemoryId { get; }

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

ReasoningEngineId

public string ReasoningEngineId { get; }

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

Property Value
Type Description
string

Type

public MemoryName.ResourceNameType Type { get; }

The MemoryName.ResourceNameType of the contained resource name.

Property Value
Type Description
MemoryNameResourceNameType

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 reasoningEngineId, string memoryId)

Formats the IDs into the string representation of this MemoryName with pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}.

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

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

The string representation of this MemoryName with pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}.

FormatProjectLocationReasoningEngineMemory(string, string, string, string)

public static string FormatProjectLocationReasoningEngineMemory(string projectId, string locationId, string reasoningEngineId, string memoryId)

Formats the IDs into the string representation of this MemoryName with pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}.

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

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

The string representation of this MemoryName with pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}.

FromProjectLocationReasoningEngineMemory(string, string, string, string)

public static MemoryName FromProjectLocationReasoningEngineMemory(string projectId, string locationId, string reasoningEngineId, string memoryId)

Creates a MemoryName with the pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}.

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

The Memory ID. Must not be null or empty.
Returns
Type Description
MemoryName

A new instance of MemoryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MemoryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MemoryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
memoryName string

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

The parsed MemoryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}

Parse(string, bool)

public static MemoryName Parse(string memoryName, bool allowUnparsed)

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

Parameters
Name Description
memoryName 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
MemoryName

The parsed MemoryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}
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 MemoryName)

public static bool TryParse(string memoryName, out MemoryName result)

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

Parameters
Name Description
memoryName string

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

When this method returns, the parsed MemoryName, 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}/reasoningEngines/{reasoning_engine}/memories/{memory}

TryParse(string, bool, out MemoryName)

public static bool TryParse(string memoryName, bool allowUnparsed, out MemoryName result)

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

Parameters
Name Description
memoryName 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 MemoryName

When this method returns, the parsed MemoryName, 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}/reasoningEngines/{reasoning_engine}/memories/{memory}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(MemoryName, MemoryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MemoryName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MemoryName

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

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.