Discovery Engine v1beta API - Class CustomTuningModelName (1.0.0-beta18) 

public sealed class CustomTuningModelName : IResourceName, IEquatable<CustomTuningModelName>

Reference documentation and code samples for the Discovery Engine v1beta API class CustomTuningModelName.

Resource name for the CustomTuningModel resource.

Inheritance

object > CustomTuningModelName

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

CustomTuningModelName(string, string, string, string)

public CustomTuningModelName(string projectId, string locationId, string dataStoreId, string customTuningModelId)

Constructs a new instance of a CustomTuningModelName class from the component parts of pattern projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}

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

The DataStore ID. Must not be null or empty.
customTuningModelId string

The CustomTuningModel ID. Must not be null or empty.

Properties

CollectionId

public string CollectionId { get; }

The Collection ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

CustomTuningModelId

public string CustomTuningModelId { get; }

The CustomTuningModel ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

DataStoreId

public string DataStoreId { get; }

The DataStore ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public CustomTuningModelName.ResourceNameType Type { get; }

The CustomTuningModelName.ResourceNameType of the contained resource name.

Property Value
Type Description
CustomTuningModelNameResourceNameType

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 dataStoreId, string customTuningModelId)

Formats the IDs into the string representation of this CustomTuningModelName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model} .

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

The DataStore ID. Must not be null or empty.
customTuningModelId string

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

The string representation of this CustomTuningModelName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model} .

FormatProjectLocationCollectionDataStoreCustomTuningModel(string, string, string, string, string)

public static string FormatProjectLocationCollectionDataStoreCustomTuningModel(string projectId, string locationId, string collectionId, string dataStoreId, string customTuningModelId)

Formats the IDs into the string representation of this CustomTuningModelName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model} .

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

The Collection ID. Must not be null or empty.
dataStoreId string

The DataStore ID. Must not be null or empty.
customTuningModelId string

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

The string representation of this CustomTuningModelName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model} .

FormatProjectLocationDataStoreCustomTuningModel(string, string, string, string)

public static string FormatProjectLocationDataStoreCustomTuningModel(string projectId, string locationId, string dataStoreId, string customTuningModelId)

Formats the IDs into the string representation of this CustomTuningModelName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model} .

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

The DataStore ID. Must not be null or empty.
customTuningModelId string

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

The string representation of this CustomTuningModelName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model} .

FromProjectLocationCollectionDataStoreCustomTuningModel(string, string, string, string, string)

public static CustomTuningModelName FromProjectLocationCollectionDataStoreCustomTuningModel(string projectId, string locationId, string collectionId, string dataStoreId, string customTuningModelId)

Creates a CustomTuningModelName with the pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model} .

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

The Collection ID. Must not be null or empty.
dataStoreId string

The DataStore ID. Must not be null or empty.
customTuningModelId string

The CustomTuningModel ID. Must not be null or empty.
Returns
Type Description
CustomTuningModelName

A new instance of CustomTuningModelName constructed from the provided ids.

FromProjectLocationDataStoreCustomTuningModel(string, string, string, string)

public static CustomTuningModelName FromProjectLocationDataStoreCustomTuningModel(string projectId, string locationId, string dataStoreId, string customTuningModelId)

Creates a CustomTuningModelName with the pattern projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model} .

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

The DataStore ID. Must not be null or empty.
customTuningModelId string

The CustomTuningModel ID. Must not be null or empty.
Returns
Type Description
CustomTuningModelName

A new instance of CustomTuningModelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CustomTuningModelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CustomTuningModelName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
customTuningModelName string

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

The parsed CustomTuningModelName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}

Parse(string, bool)

public static CustomTuningModelName Parse(string customTuningModelName, bool allowUnparsed)

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

Parameters
Name Description
customTuningModelName 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
CustomTuningModelName

The parsed CustomTuningModelName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}
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 CustomTuningModelName)

public static bool TryParse(string customTuningModelName, out CustomTuningModelName result)

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

Parameters
Name Description
customTuningModelName string

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

When this method returns, the parsed CustomTuningModelName, 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}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}

TryParse(string, bool, out CustomTuningModelName)

public static bool TryParse(string customTuningModelName, bool allowUnparsed, out CustomTuningModelName result)

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

Parameters
Name Description
customTuningModelName 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 CustomTuningModelName

When this method returns, the parsed CustomTuningModelName, 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}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CustomTuningModelName, CustomTuningModelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CustomTuningModelName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CustomTuningModelName

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

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.