Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Vertex AI v1beta1 API - Class MemoryRevisionName (1.0.0-beta86)

public sealed class MemoryRevisionName : IResourceName, IEquatable<MemoryRevisionName>

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

Resource name for the MemoryRevision resource.

Inheritance

object > MemoryRevisionName

Implements

IResourceName, IEquatable MemoryRevisionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

MemoryRevisionName(string, string, string, string, string)

public MemoryRevisionName(string projectId, string locationId, string reasoningEngineId, string memoryId, string memoryRevisionId)

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

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.
`memoryRevisionId`	`string` The `MemoryRevision` 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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

MemoryBankId

public string MemoryBankId { get; }

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

Property Value
Type	Description
`string`

MemoryId

public string MemoryId { get; }

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

Property Value
Type	Description
`string`

MemoryRevisionId

public string MemoryRevisionId { get; }

The MemoryRevision 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`

Type

public MemoryRevisionName.ResourceNameType Type { get; }

The MemoryRevisionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`MemoryRevisionNameResourceNameType`

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

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

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.
`memoryRevisionId`	`string` The `MemoryRevision` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MemoryRevisionName with pattern `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` .

FormatProjectLocationMemoryBankMemoryMemoryRevision(string, string, string, string, string)

public static string FormatProjectLocationMemoryBankMemoryMemoryRevision(string projectId, string locationId, string memoryBankId, string memoryId, string memoryRevisionId)

Formats the IDs into the string representation of this MemoryRevisionName with pattern projects/{project}/locations/{location}/memoryBanks/{memory_bank}/memories/{memory}/revisions/{memory_revision} .

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.
`memoryBankId`	`string` The `MemoryBank` ID. Must not be `null` or empty.
`memoryId`	`string` The `Memory` ID. Must not be `null` or empty.
`memoryRevisionId`	`string` The `MemoryRevision` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MemoryRevisionName with pattern `projects/{project}/locations/{location}/memoryBanks/{memory_bank}/memories/{memory}/revisions/{memory_revision}` .

FormatProjectLocationReasoningEngineMemoryMemoryRevision(string, string, string, string, string)

public static string FormatProjectLocationReasoningEngineMemoryMemoryRevision(string projectId, string locationId, string reasoningEngineId, string memoryId, string memoryRevisionId)

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.
`memoryRevisionId`	`string` The `MemoryRevision` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MemoryRevisionName with pattern `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` .

FromProjectLocationMemoryBankMemoryMemoryRevision(string, string, string, string, string)

public static MemoryRevisionName FromProjectLocationMemoryBankMemoryMemoryRevision(string projectId, string locationId, string memoryBankId, string memoryId, string memoryRevisionId)

Creates a MemoryRevisionName with the pattern projects/{project}/locations/{location}/memoryBanks/{memory_bank}/memories/{memory}/revisions/{memory_revision} .

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.
`memoryBankId`	`string` The `MemoryBank` ID. Must not be `null` or empty.
`memoryId`	`string` The `Memory` ID. Must not be `null` or empty.
`memoryRevisionId`	`string` The `MemoryRevision` ID. Must not be `null` or empty.

Returns
Type	Description
`MemoryRevisionName`	A new instance of MemoryRevisionName constructed from the provided ids.

FromProjectLocationReasoningEngineMemoryMemoryRevision(string, string, string, string, string)

public static MemoryRevisionName FromProjectLocationReasoningEngineMemoryMemoryRevision(string projectId, string locationId, string reasoningEngineId, string memoryId, string memoryRevisionId)

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

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.
`memoryRevisionId`	`string` The `MemoryRevision` ID. Must not be `null` or empty.

Returns
Type	Description
`MemoryRevisionName`	A new instance of MemoryRevisionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MemoryRevisionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MemoryRevisionName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`MemoryRevisionName`	A new instance of MemoryRevisionName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static MemoryRevisionName Parse(string memoryRevisionName)

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

Parameter
Name	Description
`memoryRevisionName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`MemoryRevisionName`	The parsed MemoryRevisionName 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}/revisions/{memory_revision}
projects/{project}/locations/{location}/memoryBanks/{memory_bank}/memories/{memory}/revisions/{memory_revision}

Parse(string, bool)

public static MemoryRevisionName Parse(string memoryRevisionName, bool allowUnparsed)

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

Parameters
Name	Description
`memoryRevisionName`	`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
`MemoryRevisionName`	The parsed MemoryRevisionName 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}/revisions/{memory_revision}
projects/{project}/locations/{location}/memoryBanks/{memory_bank}/memories/{memory}/revisions/{memory_revision}

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

object.ToString()

TryParse(string, out MemoryRevisionName)

public static bool TryParse(string memoryRevisionName, out MemoryRevisionName result)

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

Parameters
Name	Description
`memoryRevisionName`	`string` The resource name in string form. Must not be `null`.
`result`	`MemoryRevisionName` When this method returns, the parsed MemoryRevisionName, 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}/revisions/{memory_revision}
projects/{project}/locations/{location}/memoryBanks/{memory_bank}/memories/{memory}/revisions/{memory_revision}

TryParse(string, bool, out MemoryRevisionName)

public static bool TryParse(string memoryRevisionName, bool allowUnparsed, out MemoryRevisionName result)

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

Parameters
Name	Description
`memoryRevisionName`	`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`	`MemoryRevisionName` When this method returns, the parsed MemoryRevisionName, 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}/revisions/{memory_revision}
projects/{project}/locations/{location}/memoryBanks/{memory_bank}/memories/{memory}/revisions/{memory_revision}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MemoryRevisionName, MemoryRevisionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`MemoryRevisionName` The first resource name to compare, or null.
`b`	`MemoryRevisionName` 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 !=(MemoryRevisionName, MemoryRevisionName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`MemoryRevisionName` The first resource name to compare, or null.
`b`	`MemoryRevisionName` 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.