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

public sealed class SeriesName : IResourceName, IEquatable<SeriesName>

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

Resource name for the Series resource.

Inheritance

object > SeriesName

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

SeriesName(string, string, string, string)

public SeriesName(string projectId, string locationId, string clusterId, string seriesId)

Constructs a new instance of a SeriesName class from the component parts of pattern projects/{project}/locations/{location}/clusters/{cluster}/series/{series}

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

The Cluster ID. Must not be null or empty.
seriesId string

The Series ID. Must not be null or empty.

Properties

ClusterId

public string ClusterId { get; }

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

SeriesId

public string SeriesId { get; }

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

Property Value
Type Description
string

Type

public SeriesName.ResourceNameType Type { get; }

The SeriesName.ResourceNameType of the contained resource name.

Property Value
Type Description
SeriesNameResourceNameType

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 clusterId, string seriesId)

Formats the IDs into the string representation of this SeriesName with pattern projects/{project}/locations/{location}/clusters/{cluster}/series/{series}.

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

The Cluster ID. Must not be null or empty.
seriesId string

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

The string representation of this SeriesName with pattern projects/{project}/locations/{location}/clusters/{cluster}/series/{series}.

FormatProjectLocationClusterSeries(string, string, string, string)

public static string FormatProjectLocationClusterSeries(string projectId, string locationId, string clusterId, string seriesId)

Formats the IDs into the string representation of this SeriesName with pattern projects/{project}/locations/{location}/clusters/{cluster}/series/{series}.

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

The Cluster ID. Must not be null or empty.
seriesId string

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

The string representation of this SeriesName with pattern projects/{project}/locations/{location}/clusters/{cluster}/series/{series}.

FromProjectLocationClusterSeries(string, string, string, string)

public static SeriesName FromProjectLocationClusterSeries(string projectId, string locationId, string clusterId, string seriesId)

Creates a SeriesName with the pattern projects/{project}/locations/{location}/clusters/{cluster}/series/{series}.

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

The Cluster ID. Must not be null or empty.
seriesId string

The Series ID. Must not be null or empty.
Returns
Type Description
SeriesName

A new instance of SeriesName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SeriesName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SeriesName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
seriesName string

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

The parsed SeriesName if successful.
Remarks

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

  • projects/{project}/locations/{location}/clusters/{cluster}/series/{series}

Parse(string, bool)

public static SeriesName Parse(string seriesName, bool allowUnparsed)

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

Parameters
Name Description
seriesName 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
SeriesName

The parsed SeriesName if successful.
Remarks

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

  • projects/{project}/locations/{location}/clusters/{cluster}/series/{series}
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 SeriesName)

public static bool TryParse(string seriesName, out SeriesName result)

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

Parameters
Name Description
seriesName string

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

When this method returns, the parsed SeriesName, 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}/clusters/{cluster}/series/{series}

TryParse(string, bool, out SeriesName)

public static bool TryParse(string seriesName, bool allowUnparsed, out SeriesName result)

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

Parameters
Name Description
seriesName 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 SeriesName

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

Operators

operator ==(SeriesName, SeriesName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SeriesName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SeriesName

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

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.