Vertex AI v1 API - Class RagFileName (3.50.0) 

public sealed class RagFileName : IResourceName, IEquatable<RagFileName>

Reference documentation and code samples for the Vertex AI v1 API class RagFileName.

Resource name for the RagFile resource.

Inheritance

object > RagFileName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

RagFileName(string, string, string, string)

public RagFileName(string projectId, string locationId, string ragCorpusId, string ragFileId)

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

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.

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

Type

public RagFileName.ResourceNameType Type { get; }

The RagFileName.ResourceNameType of the contained resource name.

Property Value
Type Description
RagFileNameResourceNameType

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

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

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.
Returns
Type Description
string

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

FormatProjectLocationRagCorpusRagFile(string, string, string, string)

public static string FormatProjectLocationRagCorpusRagFile(string projectId, string locationId, string ragCorpusId, string ragFileId)

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

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.
Returns
Type Description
string

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

FromProjectLocationRagCorpusRagFile(string, string, string, string)

public static RagFileName FromProjectLocationRagCorpusRagFile(string projectId, string locationId, string ragCorpusId, string ragFileId)

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

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.
Returns
Type Description
RagFileName

A new instance of RagFileName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RagFileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RagFileName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
ragFileName string

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

The parsed RagFileName 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}

Parse(string, bool)

public static RagFileName Parse(string ragFileName, bool allowUnparsed)

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

Parameters
Name Description
ragFileName 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
RagFileName

The parsed RagFileName 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}
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 RagFileName)

public static bool TryParse(string ragFileName, out RagFileName result)

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

Parameters
Name Description
ragFileName string

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

When this method returns, the parsed RagFileName, 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}

TryParse(string, bool, out RagFileName)

public static bool TryParse(string ragFileName, bool allowUnparsed, out RagFileName result)

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

Parameters
Name Description
ragFileName 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 RagFileName

When this method returns, the parsed RagFileName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RagFileName, RagFileName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RagFileName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RagFileName

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

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.