Vertex AI v1beta1 API - Class RagEngineConfigName (1.0.0-beta25) 

public sealed class RagEngineConfigName : IResourceName, IEquatable<RagEngineConfigName>

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

Resource name for the RagEngineConfig resource.

Inheritance

object > RagEngineConfigName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

RagEngineConfigName(string, string)

public RagEngineConfigName(string projectId, string locationId)

Constructs a new instance of a RagEngineConfigName class from the component parts of pattern projects/{project}/locations/{location}/ragEngineConfig

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.

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

Type

public RagEngineConfigName.ResourceNameType Type { get; }

The RagEngineConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
RagEngineConfigNameResourceNameType

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)

public static string Format(string projectId, string locationId)

Formats the IDs into the string representation of this RagEngineConfigName with pattern projects/{project}/locations/{location}/ragEngineConfig.

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

The string representation of this RagEngineConfigName with pattern projects/{project}/locations/{location}/ragEngineConfig.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this RagEngineConfigName with pattern projects/{project}/locations/{location}/ragEngineConfig.

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

The string representation of this RagEngineConfigName with pattern projects/{project}/locations/{location}/ragEngineConfig.

FromProjectLocation(string, string)

public static RagEngineConfigName FromProjectLocation(string projectId, string locationId)

Creates a RagEngineConfigName with the pattern projects/{project}/locations/{location}/ragEngineConfig.

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

A new instance of RagEngineConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RagEngineConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RagEngineConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
ragEngineConfigName string

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

The parsed RagEngineConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/ragEngineConfig

Parse(string, bool)

public static RagEngineConfigName Parse(string ragEngineConfigName, bool allowUnparsed)

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

Parameters
Name Description
ragEngineConfigName 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
RagEngineConfigName

The parsed RagEngineConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/ragEngineConfig
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 RagEngineConfigName)

public static bool TryParse(string ragEngineConfigName, out RagEngineConfigName result)

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

Parameters
Name Description
ragEngineConfigName string

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

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

TryParse(string, bool, out RagEngineConfigName)

public static bool TryParse(string ragEngineConfigName, bool allowUnparsed, out RagEngineConfigName result)

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

Parameters
Name Description
ragEngineConfigName 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 RagEngineConfigName

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

Operators

operator ==(RagEngineConfigName, RagEngineConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RagEngineConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RagEngineConfigName

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

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.