Google Cloud Translation v3 API - Class AdaptiveMtDatasetName (3.4.0)

public sealed class AdaptiveMtDatasetName : IResourceName, IEquatable<AdaptiveMtDatasetName>

Reference documentation and code samples for the Google Cloud Translation v3 API class AdaptiveMtDatasetName.

Resource name for the AdaptiveMtDataset resource.

Inheritance

object > AdaptiveMtDatasetName

Namespace

Google.Cloud.Translate.V3

Assembly

Google.Cloud.Translate.V3.dll

Constructors

AdaptiveMtDatasetName(string, string, string)

public AdaptiveMtDatasetName(string projectId, string locationId, string datasetId)

Constructs a new instance of a AdaptiveMtDatasetName class from the component parts of pattern projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

datasetIdstring

The Dataset ID. Must not be null or empty.

Properties

DatasetId

public string DatasetId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public AdaptiveMtDatasetName.ResourceNameType Type { get; }

The AdaptiveMtDatasetName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AdaptiveMtDatasetNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string datasetId)

Formats the IDs into the string representation of this AdaptiveMtDatasetName with pattern projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

datasetIdstring

The Dataset ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this AdaptiveMtDatasetName with pattern projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}.

FormatProjectLocationDataset(string, string, string)

public static string FormatProjectLocationDataset(string projectId, string locationId, string datasetId)

Formats the IDs into the string representation of this AdaptiveMtDatasetName with pattern projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

datasetIdstring

The Dataset ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this AdaptiveMtDatasetName with pattern projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}.

FromProjectLocationDataset(string, string, string)

public static AdaptiveMtDatasetName FromProjectLocationDataset(string projectId, string locationId, string datasetId)

Creates a AdaptiveMtDatasetName with the pattern projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

datasetIdstring

The Dataset ID. Must not be null or empty.

Returns
TypeDescription
AdaptiveMtDatasetName

A new instance of AdaptiveMtDatasetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AdaptiveMtDatasetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AdaptiveMtDatasetName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AdaptiveMtDatasetName

A new instance of AdaptiveMtDatasetName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static AdaptiveMtDatasetName Parse(string adaptiveMtDatasetName)

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

Parameter
NameDescription
adaptiveMtDatasetNamestring

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

Returns
TypeDescription
AdaptiveMtDatasetName

The parsed AdaptiveMtDatasetName if successful.

Remarks

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

  • projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}

Parse(string, bool)

public static AdaptiveMtDatasetName Parse(string adaptiveMtDatasetName, bool allowUnparsed)

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

Parameters
NameDescription
adaptiveMtDatasetNamestring

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

allowUnparsedbool

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
TypeDescription
AdaptiveMtDatasetName

The parsed AdaptiveMtDatasetName if successful.

Remarks

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

  • projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out AdaptiveMtDatasetName)

public static bool TryParse(string adaptiveMtDatasetName, out AdaptiveMtDatasetName result)

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

Parameters
NameDescription
adaptiveMtDatasetNamestring

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

resultAdaptiveMtDatasetName

When this method returns, the parsed AdaptiveMtDatasetName, or null if parsing failed.

Returns
TypeDescription
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}/adaptiveMtDatasets/{dataset}

TryParse(string, bool, out AdaptiveMtDatasetName)

public static bool TryParse(string adaptiveMtDatasetName, bool allowUnparsed, out AdaptiveMtDatasetName result)

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

Parameters
NameDescription
adaptiveMtDatasetNamestring

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

allowUnparsedbool

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.

resultAdaptiveMtDatasetName

When this method returns, the parsed AdaptiveMtDatasetName, or null if parsing failed.

Returns
TypeDescription
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}/adaptiveMtDatasets/{dataset}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AdaptiveMtDatasetName, AdaptiveMtDatasetName)

public static bool operator ==(AdaptiveMtDatasetName a, AdaptiveMtDatasetName b)
Parameters
NameDescription
aAdaptiveMtDatasetName
bAdaptiveMtDatasetName
Returns
TypeDescription
bool

operator !=(AdaptiveMtDatasetName, AdaptiveMtDatasetName)

public static bool operator !=(AdaptiveMtDatasetName a, AdaptiveMtDatasetName b)
Parameters
NameDescription
aAdaptiveMtDatasetName
bAdaptiveMtDatasetName
Returns
TypeDescription
bool