Discovery Engine v1 API - Class GroundingConfigName (1.10.0) 

public sealed class GroundingConfigName : IResourceName, IEquatable<GroundingConfigName>

Reference documentation and code samples for the Discovery Engine v1 API class GroundingConfigName.

Resource name for the GroundingConfig resource.

Inheritance

object > GroundingConfigName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

GroundingConfigName(string, string, string)

public GroundingConfigName(string projectId, string locationId, string groundingConfigId)

Constructs a new instance of a GroundingConfigName class from the component parts of pattern projects/{project}/locations/{location}/groundingConfigs/{grounding_config}

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

The GroundingConfig ID. Must not be null or empty.

Properties

GroundingConfigId

public string GroundingConfigId { get; }

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

Property Value
Type Description
string

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 GroundingConfigName.ResourceNameType Type { get; }

The GroundingConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
GroundingConfigNameResourceNameType

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

Formats the IDs into the string representation of this GroundingConfigName with pattern projects/{project}/locations/{location}/groundingConfigs/{grounding_config}.

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

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

The string representation of this GroundingConfigName with pattern projects/{project}/locations/{location}/groundingConfigs/{grounding_config}.

FormatProjectLocationGroundingConfig(string, string, string)

public static string FormatProjectLocationGroundingConfig(string projectId, string locationId, string groundingConfigId)

Formats the IDs into the string representation of this GroundingConfigName with pattern projects/{project}/locations/{location}/groundingConfigs/{grounding_config}.

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

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

The string representation of this GroundingConfigName with pattern projects/{project}/locations/{location}/groundingConfigs/{grounding_config}.

FromProjectLocationGroundingConfig(string, string, string)

public static GroundingConfigName FromProjectLocationGroundingConfig(string projectId, string locationId, string groundingConfigId)

Creates a GroundingConfigName with the pattern projects/{project}/locations/{location}/groundingConfigs/{grounding_config}.

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

The GroundingConfig ID. Must not be null or empty.
Returns
Type Description
GroundingConfigName

A new instance of GroundingConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GroundingConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GroundingConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
groundingConfigName string

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

The parsed GroundingConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/groundingConfigs/{grounding_config}

Parse(string, bool)

public static GroundingConfigName Parse(string groundingConfigName, bool allowUnparsed)

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

Parameters
Name Description
groundingConfigName 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
GroundingConfigName

The parsed GroundingConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/groundingConfigs/{grounding_config}
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 GroundingConfigName)

public static bool TryParse(string groundingConfigName, out GroundingConfigName result)

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

Parameters
Name Description
groundingConfigName string

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

When this method returns, the parsed GroundingConfigName, 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}/groundingConfigs/{grounding_config}

TryParse(string, bool, out GroundingConfigName)

public static bool TryParse(string groundingConfigName, bool allowUnparsed, out GroundingConfigName result)

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

Parameters
Name Description
groundingConfigName 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 GroundingConfigName

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

Operators

operator ==(GroundingConfigName, GroundingConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GroundingConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GroundingConfigName

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

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.