Vertex AI v1beta1 API - Class RagMetadataName (1.0.0-beta74) 

public sealed class RagMetadataName : IResourceName, IEquatable<RagMetadataName>

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

Resource name for the RagMetadata resource.

Inheritance

object > RagMetadataName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

RagMetadataName(string, string, string, string, string)

public RagMetadataName(string projectId, string locationId, string ragCorpusId, string ragFileId, string ragMetadataId)

Constructs a new instance of a RagMetadataName class from the component parts of pattern projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}

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

The RagFile ID. Must not be null or empty.
ragMetadataId string

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

RagFileId

public string RagFileId { get; }

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

Property Value
Type Description
string

RagMetadataId

public string RagMetadataId { get; }

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

Property Value
Type Description
string

Type

public RagMetadataName.ResourceNameType Type { get; }

The RagMetadataName.ResourceNameType of the contained resource name.

Property Value
Type Description
RagMetadataNameResourceNameType

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 ragCorpusId, string ragFileId, string ragMetadataId)

Formats the IDs into the string representation of this RagMetadataName with pattern projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata} .

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

The RagFile ID. Must not be null or empty.
ragMetadataId string

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

The string representation of this RagMetadataName with pattern projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata} .

FormatProjectLocationRagCorpusRagFileRagMetadata(string, string, string, string, string)

public static string FormatProjectLocationRagCorpusRagFileRagMetadata(string projectId, string locationId, string ragCorpusId, string ragFileId, string ragMetadataId)

Formats the IDs into the string representation of this RagMetadataName with pattern projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata} .

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

The RagFile ID. Must not be null or empty.
ragMetadataId string

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

The string representation of this RagMetadataName with pattern projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata} .

FromProjectLocationRagCorpusRagFileRagMetadata(string, string, string, string, string)

public static RagMetadataName FromProjectLocationRagCorpusRagFileRagMetadata(string projectId, string locationId, string ragCorpusId, string ragFileId, string ragMetadataId)

Creates a RagMetadataName with the pattern projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata} .

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

The RagFile ID. Must not be null or empty.
ragMetadataId string

The RagMetadata ID. Must not be null or empty.
Returns
Type Description
RagMetadataName

A new instance of RagMetadataName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RagMetadataName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RagMetadataName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
ragMetadataName string

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

The parsed RagMetadataName if successful.
Remarks

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

  • projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}

Parse(string, bool)

public static RagMetadataName Parse(string ragMetadataName, bool allowUnparsed)

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

Parameters
Name Description
ragMetadataName 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
RagMetadataName

The parsed RagMetadataName if successful.
Remarks

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

  • projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}

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

public static bool TryParse(string ragMetadataName, out RagMetadataName result)

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

Parameters
Name Description
ragMetadataName string

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

When this method returns, the parsed RagMetadataName, 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}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}

TryParse(string, bool, out RagMetadataName)

public static bool TryParse(string ragMetadataName, bool allowUnparsed, out RagMetadataName result)

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

Parameters
Name Description
ragMetadataName 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 RagMetadataName

When this method returns, the parsed RagMetadataName, 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}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RagMetadataName, RagMetadataName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RagMetadataName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RagMetadataName

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

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.