Vision AI v1 API - Class OperatorName (1.0.0-beta01) 

public sealed class OperatorName : IResourceName, IEquatable<OperatorName>

Reference documentation and code samples for the Vision AI v1 API class OperatorName.

Resource name for the Operator resource.

Inheritance

object > OperatorName

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

OperatorName(string, string, string)

public OperatorName(string projectId, string locationId, string operatorId)

Constructs a new instance of a OperatorName class from the component parts of pattern projects/{project}/locations/{location}/operators/{operator}

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

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

OperatorId

public string OperatorId { get; }

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

The OperatorName.ResourceNameType of the contained resource name.

Property Value
Type Description
OperatorNameResourceNameType

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

Formats the IDs into the string representation of this OperatorName with pattern projects/{project}/locations/{location}/operators/{operator}.

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

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

The string representation of this OperatorName with pattern projects/{project}/locations/{location}/operators/{operator}.

FormatProjectLocationOperator(string, string, string)

public static string FormatProjectLocationOperator(string projectId, string locationId, string operatorId)

Formats the IDs into the string representation of this OperatorName with pattern projects/{project}/locations/{location}/operators/{operator}.

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

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

The string representation of this OperatorName with pattern projects/{project}/locations/{location}/operators/{operator}.

FromProjectLocationOperator(string, string, string)

public static OperatorName FromProjectLocationOperator(string projectId, string locationId, string operatorId)

Creates a OperatorName with the pattern projects/{project}/locations/{location}/operators/{operator}.

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

The Operator ID. Must not be null or empty.
Returns
Type Description
OperatorName

A new instance of OperatorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OperatorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OperatorName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
operatorName string

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

The parsed OperatorName if successful.
Remarks

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

  • projects/{project}/locations/{location}/operators/{operator}

Parse(string, bool)

public static OperatorName Parse(string operatorName, bool allowUnparsed)

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

Parameters
Name Description
operatorName 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
OperatorName

The parsed OperatorName if successful.
Remarks

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

  • projects/{project}/locations/{location}/operators/{operator}
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 OperatorName)

public static bool TryParse(string operatorName, out OperatorName result)

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

Parameters
Name Description
operatorName string

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

When this method returns, the parsed OperatorName, 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}/operators/{operator}

TryParse(string, bool, out OperatorName)

public static bool TryParse(string operatorName, bool allowUnparsed, out OperatorName result)

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

Parameters
Name Description
operatorName 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 OperatorName

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

Operators

operator ==(OperatorName, OperatorName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OperatorName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OperatorName

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

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.