Cloud Document AI v1beta3 API - Class DatasetName (2.0.0-beta22) 

public sealed class DatasetName : IResourceName, IEquatable<DatasetName>

Reference documentation and code samples for the Cloud Document AI v1beta3 API class DatasetName.

Resource name for the Dataset resource.

Inheritance

object > DatasetName

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Constructors

DatasetName(string, string, string)

public DatasetName(string projectId, string locationId, string processorId)

Constructs a new instance of a DatasetName class from the component parts of pattern projects/{project}/locations/{location}/processors/{processor}/dataset

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

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

ProcessorId

public string ProcessorId { get; }

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

The DatasetName.ResourceNameType of the contained resource name.

Property Value
Type Description
DatasetNameResourceNameType

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

Formats the IDs into the string representation of this DatasetName with pattern projects/{project}/locations/{location}/processors/{processor}/dataset.

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

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

The string representation of this DatasetName with pattern projects/{project}/locations/{location}/processors/{processor}/dataset.

FormatProjectLocationProcessor(string, string, string)

public static string FormatProjectLocationProcessor(string projectId, string locationId, string processorId)

Formats the IDs into the string representation of this DatasetName with pattern projects/{project}/locations/{location}/processors/{processor}/dataset.

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

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

The string representation of this DatasetName with pattern projects/{project}/locations/{location}/processors/{processor}/dataset.

FromProjectLocationProcessor(string, string, string)

public static DatasetName FromProjectLocationProcessor(string projectId, string locationId, string processorId)

Creates a DatasetName with the pattern projects/{project}/locations/{location}/processors/{processor}/dataset.

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

The Processor ID. Must not be null or empty.
Returns
Type Description
DatasetName

A new instance of DatasetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DatasetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DatasetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
datasetName string

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

The parsed DatasetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/processors/{processor}/dataset

Parse(string, bool)

public static DatasetName Parse(string datasetName, bool allowUnparsed)

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

Parameters
Name Description
datasetName 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
DatasetName

The parsed DatasetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/processors/{processor}/dataset
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 DatasetName)

public static bool TryParse(string datasetName, out DatasetName result)

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

Parameters
Name Description
datasetName string

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

When this method returns, the parsed DatasetName, 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}/processors/{processor}/dataset

TryParse(string, bool, out DatasetName)

public static bool TryParse(string datasetName, bool allowUnparsed, out DatasetName result)

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

Parameters
Name Description
datasetName 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 DatasetName

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

Operators

operator ==(DatasetName, DatasetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DatasetName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DatasetName

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

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.