Cloud AI Platform v1beta1 API - Class ReasoningEngineName (1.0.0-beta09) 

public sealed class ReasoningEngineName : IResourceName, IEquatable<ReasoningEngineName>

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class ReasoningEngineName.

Resource name for the ReasoningEngine resource.

Inheritance

object > ReasoningEngineName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

ReasoningEngineName(string, string, string)

public ReasoningEngineName(string projectId, string locationId, string reasoningEngineId)

Constructs a new instance of a ReasoningEngineName class from the component parts of pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_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.
reasoningEngineId string

The ReasoningEngine 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

ReasoningEngineId

public string ReasoningEngineId { get; }

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

Property Value
Type Description
string

Type

public ReasoningEngineName.ResourceNameType Type { get; }

The ReasoningEngineName.ResourceNameType of the contained resource name.

Property Value
Type Description
ReasoningEngineNameResourceNameType

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

Formats the IDs into the string representation of this ReasoningEngineName with pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_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.
reasoningEngineId string

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

The string representation of this ReasoningEngineName with pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}.

FormatProjectLocationReasoningEngine(string, string, string)

public static string FormatProjectLocationReasoningEngine(string projectId, string locationId, string reasoningEngineId)

Formats the IDs into the string representation of this ReasoningEngineName with pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_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.
reasoningEngineId string

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

The string representation of this ReasoningEngineName with pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}.

FromProjectLocationReasoningEngine(string, string, string)

public static ReasoningEngineName FromProjectLocationReasoningEngine(string projectId, string locationId, string reasoningEngineId)

Creates a ReasoningEngineName with the pattern projects/{project}/locations/{location}/reasoningEngines/{reasoning_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.
reasoningEngineId string

The ReasoningEngine ID. Must not be null or empty.
Returns
Type Description
ReasoningEngineName

A new instance of ReasoningEngineName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReasoningEngineName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReasoningEngineName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
reasoningEngineName string

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

The parsed ReasoningEngineName if successful.
Remarks

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

  • projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

Parse(string, bool)

public static ReasoningEngineName Parse(string reasoningEngineName, bool allowUnparsed)

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

Parameters
Name Description
reasoningEngineName 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
ReasoningEngineName

The parsed ReasoningEngineName if successful.
Remarks

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

  • projects/{project}/locations/{location}/reasoningEngines/{reasoning_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 ReasoningEngineName)

public static bool TryParse(string reasoningEngineName, out ReasoningEngineName result)

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

Parameters
Name Description
reasoningEngineName string

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

When this method returns, the parsed ReasoningEngineName, 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}/reasoningEngines/{reasoning_engine}

TryParse(string, bool, out ReasoningEngineName)

public static bool TryParse(string reasoningEngineName, bool allowUnparsed, out ReasoningEngineName result)

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

Parameters
Name Description
reasoningEngineName 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 ReasoningEngineName

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

Operators

operator ==(ReasoningEngineName, ReasoningEngineName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ReasoningEngineName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ReasoningEngineName

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

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.