Discovery Engine v1 API - Class EngineName (1.10.0) 

public sealed class EngineName : IResourceName, IEquatable<EngineName>

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

Resource name for the Engine resource.

Inheritance

object > EngineName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

EngineName(string, string, string, string)

public EngineName(string projectId, string locationId, string collectionId, string engineId)

Constructs a new instance of a EngineName class from the component parts of pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

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.

Properties

CollectionId

public string CollectionId { get; }

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

Property Value
Type Description
string

EngineId

public string EngineId { get; }

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

The EngineName.ResourceNameType of the contained resource name.

Property Value
Type Description
EngineNameResourceNameType

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 collectionId, string engineId)

Formats the IDs into the string representation of this EngineName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}.

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

The string representation of this EngineName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}.

FormatProjectLocationCollectionEngine(string, string, string, string)

public static string FormatProjectLocationCollectionEngine(string projectId, string locationId, string collectionId, string engineId)

Formats the IDs into the string representation of this EngineName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}.

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

The string representation of this EngineName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}.

FromProjectLocationCollectionEngine(string, string, string, string)

public static EngineName FromProjectLocationCollectionEngine(string projectId, string locationId, string collectionId, string engineId)

Creates a EngineName with the pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}.

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

A new instance of EngineName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EngineName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EngineName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
engineName string

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

The parsed EngineName if successful.
Remarks

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

  • projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Parse(string, bool)

public static EngineName Parse(string engineName, bool allowUnparsed)

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

Parameters
Name Description
engineName 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
EngineName

The parsed EngineName if successful.
Remarks

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

  • projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
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 EngineName)

public static bool TryParse(string engineName, out EngineName result)

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

Parameters
Name Description
engineName string

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

When this method returns, the parsed EngineName, 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}/collections/{collection}/engines/{engine}

TryParse(string, bool, out EngineName)

public static bool TryParse(string engineName, bool allowUnparsed, out EngineName result)

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

Parameters
Name Description
engineName 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 EngineName

When this method returns, the parsed EngineName, 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}/collections/{collection}/engines/{engine}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EngineName, EngineName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EngineName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EngineName

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

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.