Discovery Engine v1 API - Class WidgetConfigName (1.17.0)

1.17.0 (latest) 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0-beta06

public sealed class WidgetConfigName : IResourceName, IEquatable<WidgetConfigName>

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

Resource name for the WidgetConfig resource.

Inheritance

object > WidgetConfigName

Implements

IResourceName, IEquatableWidgetConfigName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

WidgetConfigName(string, string, string, string)

public WidgetConfigName(string projectId, string locationId, string dataStoreId, string widgetConfigId)

Constructs a new instance of a WidgetConfigName class from the component parts of pattern projects/{project}/locations/{location}/dataStores/{data_store}/widgetConfigs/{widget_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.
dataStoreId	string The DataStore ID. Must not be null or empty.
widgetConfigId	string The WidgetConfig 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

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

EngineId

public string EngineId { get; }

The Engine 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 WidgetConfigName.ResourceNameType Type { get; }

The WidgetConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
WidgetConfigNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
UnparsedResourceName

WidgetConfigId

public string WidgetConfigId { get; }

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

Property Value
Type	Description
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string dataStoreId, string widgetConfigId)

Formats the IDs into the string representation of this WidgetConfigName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/widgetConfigs/{widget_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.
dataStoreId	string The DataStore ID. Must not be null or empty.
widgetConfigId	string The WidgetConfig ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this WidgetConfigName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/widgetConfigs/{widget_config}.

FormatProjectLocationCollectionDataStoreWidgetConfig(string, string, string, string, string)

public static string FormatProjectLocationCollectionDataStoreWidgetConfig(string projectId, string locationId, string collectionId, string dataStoreId, string widgetConfigId)

Formats the IDs into the string representation of this WidgetConfigName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/widgetConfigs/{widget_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.
collectionId	string The Collection ID. Must not be null or empty.
dataStoreId	string The DataStore ID. Must not be null or empty.
widgetConfigId	string The WidgetConfig ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this WidgetConfigName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/widgetConfigs/{widget_config} .

FormatProjectLocationCollectionEngineWidgetConfig(string, string, string, string, string)

public static string FormatProjectLocationCollectionEngineWidgetConfig(string projectId, string locationId, string collectionId, string engineId, string widgetConfigId)

Formats the IDs into the string representation of this WidgetConfigName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/widgetConfigs/{widget_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.
collectionId	string The Collection ID. Must not be null or empty.
engineId	string The Engine ID. Must not be null or empty.
widgetConfigId	string The WidgetConfig ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this WidgetConfigName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/widgetConfigs/{widget_config} .

FormatProjectLocationDataStoreWidgetConfig(string, string, string, string)

public static string FormatProjectLocationDataStoreWidgetConfig(string projectId, string locationId, string dataStoreId, string widgetConfigId)

Formats the IDs into the string representation of this WidgetConfigName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/widgetConfigs/{widget_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.
dataStoreId	string The DataStore ID. Must not be null or empty.
widgetConfigId	string The WidgetConfig ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this WidgetConfigName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/widgetConfigs/{widget_config}.

FromProjectLocationCollectionDataStoreWidgetConfig(string, string, string, string, string)

public static WidgetConfigName FromProjectLocationCollectionDataStoreWidgetConfig(string projectId, string locationId, string collectionId, string dataStoreId, string widgetConfigId)

Creates a WidgetConfigName with the pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/widgetConfigs/{widget_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.
collectionId	string The Collection ID. Must not be null or empty.
dataStoreId	string The DataStore ID. Must not be null or empty.
widgetConfigId	string The WidgetConfig ID. Must not be null or empty.

Returns
Type	Description
WidgetConfigName	A new instance of WidgetConfigName constructed from the provided ids.

FromProjectLocationCollectionEngineWidgetConfig(string, string, string, string, string)

public static WidgetConfigName FromProjectLocationCollectionEngineWidgetConfig(string projectId, string locationId, string collectionId, string engineId, string widgetConfigId)

Creates a WidgetConfigName with the pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/widgetConfigs/{widget_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.
collectionId	string The Collection ID. Must not be null or empty.
engineId	string The Engine ID. Must not be null or empty.
widgetConfigId	string The WidgetConfig ID. Must not be null or empty.

Returns
Type	Description
WidgetConfigName	A new instance of WidgetConfigName constructed from the provided ids.

FromProjectLocationDataStoreWidgetConfig(string, string, string, string)

public static WidgetConfigName FromProjectLocationDataStoreWidgetConfig(string projectId, string locationId, string dataStoreId, string widgetConfigId)

Creates a WidgetConfigName with the pattern projects/{project}/locations/{location}/dataStores/{data_store}/widgetConfigs/{widget_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.
dataStoreId	string The DataStore ID. Must not be null or empty.
widgetConfigId	string The WidgetConfig ID. Must not be null or empty.

Returns
Type	Description
WidgetConfigName	A new instance of WidgetConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WidgetConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WidgetConfigName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
WidgetConfigName	A new instance of WidgetConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static WidgetConfigName Parse(string widgetConfigName)

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

Parameter
Name	Description
widgetConfigName	string The resource name in string form. Must not be null.

Returns
Type	Description
WidgetConfigName	The parsed WidgetConfigName if successful.

Remarks

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

• projects/{project}/locations/{location}/dataStores/{data_store}/widgetConfigs/{widget_config}
• projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/widgetConfigs/{widget_config}
• projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/widgetConfigs/{widget_config}

Parse(string, bool)

public static WidgetConfigName Parse(string widgetConfigName, bool allowUnparsed)

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

Parameters
Name	Description
widgetConfigName	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
WidgetConfigName	The parsed WidgetConfigName if successful.

Remarks

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

• projects/{project}/locations/{location}/dataStores/{data_store}/widgetConfigs/{widget_config}
• projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/widgetConfigs/{widget_config}
• projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/widgetConfigs/{widget_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

object.ToString()

TryParse(string, out WidgetConfigName)

public static bool TryParse(string widgetConfigName, out WidgetConfigName result)

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

Parameters
Name	Description
widgetConfigName	string The resource name in string form. Must not be null.
result	WidgetConfigName When this method returns, the parsed WidgetConfigName, 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}/widgetConfigs/{widget_config}
• projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/widgetConfigs/{widget_config}
• projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/widgetConfigs/{widget_config}

TryParse(string, bool, out WidgetConfigName)

public static bool TryParse(string widgetConfigName, bool allowUnparsed, out WidgetConfigName result)

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

Parameters
Name	Description
widgetConfigName	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	WidgetConfigName When this method returns, the parsed WidgetConfigName, 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}/widgetConfigs/{widget_config}
• projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/widgetConfigs/{widget_config}
• projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/widgetConfigs/{widget_config}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(WidgetConfigName, WidgetConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	WidgetConfigName The first resource name to compare, or null.
b	WidgetConfigName 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 !=(WidgetConfigName, WidgetConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	WidgetConfigName The first resource name to compare, or null.
b	WidgetConfigName 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.