Cloud AI Platform v1beta1 API - Class RagCorpusName (1.0.0-beta03)

public sealed class RagCorpusName : IResourceName, IEquatable<RagCorpusName>

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class RagCorpusName.

Resource name for the RagCorpus resource.

Inheritance

object > RagCorpusName

Implements

IResourceName, IEquatable RagCorpusName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

RagCorpusName(string, string, string)

public RagCorpusName(string projectId, string locationId, string ragCorpusId)

Constructs a new instance of a RagCorpusName class from the component parts of pattern projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

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.
`ragCorpusId`	`string` The `RagCorpus` 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`

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`

RagCorpusId

public string RagCorpusId { get; }

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

Property Value
Type	Description
`string`

Type

public RagCorpusName.ResourceNameType Type { get; }

The RagCorpusName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`RagCorpusNameResourceNameType`

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)

public static string Format(string projectId, string locationId, string ragCorpusId)

Formats the IDs into the string representation of this RagCorpusName with pattern projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.

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

Returns
Type	Description
`string`	The string representation of this RagCorpusName with pattern `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`.

FormatProjectLocationRagCorpus(string, string, string)

public static string FormatProjectLocationRagCorpus(string projectId, string locationId, string ragCorpusId)

Formats the IDs into the string representation of this RagCorpusName with pattern projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.

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

Returns
Type	Description
`string`	The string representation of this RagCorpusName with pattern `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`.

FromProjectLocationRagCorpus(string, string, string)

public static RagCorpusName FromProjectLocationRagCorpus(string projectId, string locationId, string ragCorpusId)

Creates a RagCorpusName with the pattern projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.

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

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

FromUnparsed(UnparsedResourceName)

public static RagCorpusName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RagCorpusName containing an unparsed resource name.

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

Returns
Type	Description
`RagCorpusName`	A new instance of RagCorpusName 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 RagCorpusName Parse(string ragCorpusName)

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

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

Returns
Type	Description
`RagCorpusName`	The parsed RagCorpusName if successful.

Remarks

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

projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

Parse(string, bool)

public static RagCorpusName Parse(string ragCorpusName, bool allowUnparsed)

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

Parameters
Name	Description
`ragCorpusName`	`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
`RagCorpusName`	The parsed RagCorpusName if successful.

Remarks

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

projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

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 RagCorpusName)

public static bool TryParse(string ragCorpusName, out RagCorpusName result)

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

Parameters
Name	Description
`ragCorpusName`	`string` The resource name in string form. Must not be `null`.
`result`	`RagCorpusName` When this method returns, the parsed RagCorpusName, 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}/ragCorpora/{rag_corpus}

TryParse(string, bool, out RagCorpusName)

public static bool TryParse(string ragCorpusName, bool allowUnparsed, out RagCorpusName result)

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

Parameters
Name	Description
`ragCorpusName`	`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`	`RagCorpusName` When this method returns, the parsed RagCorpusName, 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}/ragCorpora/{rag_corpus}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RagCorpusName, RagCorpusName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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