Google Cloud Translation v3 API - Class AdaptiveMtSentenceName (3.4.0)

public sealed class AdaptiveMtSentenceName : IResourceName, IEquatable<AdaptiveMtSentenceName>

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

Resource name for the AdaptiveMtSentence resource.

Inheritance

object > AdaptiveMtSentenceName

Implements

IResourceName, IEquatable AdaptiveMtSentenceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Translate.V3

Assembly

Google.Cloud.Translate.V3.dll

Constructors

AdaptiveMtSentenceName(string, string, string, string, string)

public AdaptiveMtSentenceName(string projectId, string locationId, string datasetId, string fileId, string sentenceId)

Constructs a new instance of a AdaptiveMtSentenceName class from the component parts of pattern projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}/adaptiveMtFiles/{file}/adaptiveMtSentences/{sentence}

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.
`datasetId`	`string` The `Dataset` ID. Must not be `null` or empty.
`fileId`	`string` The `File` ID. Must not be `null` or empty.
`sentenceId`	`string` The `Sentence` 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
Type	Description
`string`

FileId

public string FileId { get; }

The File 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`

SentenceId

public string SentenceId { get; }

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

Property Value
Type	Description
`string`

Type

public AdaptiveMtSentenceName.ResourceNameType Type { get; }

The AdaptiveMtSentenceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AdaptiveMtSentenceNameResourceNameType`

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

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

Formats the IDs into the string representation of this AdaptiveMtSentenceName with pattern projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}/adaptiveMtFiles/{file}/adaptiveMtSentences/{sentence} .

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.
`datasetId`	`string` The `Dataset` ID. Must not be `null` or empty.
`fileId`	`string` The `File` ID. Must not be `null` or empty.
`sentenceId`	`string` The `Sentence` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AdaptiveMtSentenceName with pattern `projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}/adaptiveMtFiles/{file}/adaptiveMtSentences/{sentence}` .

FormatProjectLocationDatasetFileSentence(string, string, string, string, string)

public static string FormatProjectLocationDatasetFileSentence(string projectId, string locationId, string datasetId, string fileId, string sentenceId)

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.
`datasetId`	`string` The `Dataset` ID. Must not be `null` or empty.
`fileId`	`string` The `File` ID. Must not be `null` or empty.
`sentenceId`	`string` The `Sentence` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AdaptiveMtSentenceName with pattern `projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}/adaptiveMtFiles/{file}/adaptiveMtSentences/{sentence}` .

FromProjectLocationDatasetFileSentence(string, string, string, string, string)

public static AdaptiveMtSentenceName FromProjectLocationDatasetFileSentence(string projectId, string locationId, string datasetId, string fileId, string sentenceId)

Creates a AdaptiveMtSentenceName with the pattern projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}/adaptiveMtFiles/{file}/adaptiveMtSentences/{sentence} .

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.
`datasetId`	`string` The `Dataset` ID. Must not be `null` or empty.
`fileId`	`string` The `File` ID. Must not be `null` or empty.
`sentenceId`	`string` The `Sentence` ID. Must not be `null` or empty.

Returns
Type	Description
`AdaptiveMtSentenceName`	A new instance of AdaptiveMtSentenceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AdaptiveMtSentenceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AdaptiveMtSentenceName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`AdaptiveMtSentenceName`	A new instance of AdaptiveMtSentenceName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static AdaptiveMtSentenceName Parse(string adaptiveMtSentenceName)

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

Parameter
Name	Description
`adaptiveMtSentenceName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`AdaptiveMtSentenceName`	The parsed AdaptiveMtSentenceName if successful.

Remarks

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

projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}/adaptiveMtFiles/{file}/adaptiveMtSentences/{sentence}

Parse(string, bool)

public static AdaptiveMtSentenceName Parse(string adaptiveMtSentenceName, bool allowUnparsed)

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

Parameters
Name	Description
`adaptiveMtSentenceName`	`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
`AdaptiveMtSentenceName`	The parsed AdaptiveMtSentenceName if successful.

Remarks

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

projects/{project}/locations/{location}/adaptiveMtDatasets/{dataset}/adaptiveMtFiles/{file}/adaptiveMtSentences/{sentence}

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

object.ToString()

TryParse(string, out AdaptiveMtSentenceName)

public static bool TryParse(string adaptiveMtSentenceName, out AdaptiveMtSentenceName result)

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

Parameters
Name	Description
`adaptiveMtSentenceName`	`string` The resource name in string form. Must not be `null`.
`result`	`AdaptiveMtSentenceName` When this method returns, the parsed AdaptiveMtSentenceName, 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}/adaptiveMtDatasets/{dataset}/adaptiveMtFiles/{file}/adaptiveMtSentences/{sentence}

TryParse(string, bool, out AdaptiveMtSentenceName)

public static bool TryParse(string adaptiveMtSentenceName, bool allowUnparsed, out AdaptiveMtSentenceName result)

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

Parameters
Name	Description
`adaptiveMtSentenceName`	`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`	`AdaptiveMtSentenceName` When this method returns, the parsed AdaptiveMtSentenceName, 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}/adaptiveMtDatasets/{dataset}/adaptiveMtFiles/{file}/adaptiveMtSentences/{sentence}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AdaptiveMtSentenceName, AdaptiveMtSentenceName)

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

Parameters
Name	Description
`a`	`AdaptiveMtSentenceName`
`b`	`AdaptiveMtSentenceName`

Returns
Type	Description
`bool`

operator !=(AdaptiveMtSentenceName, AdaptiveMtSentenceName)

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

Parameters
Name	Description
`a`	`AdaptiveMtSentenceName`
`b`	`AdaptiveMtSentenceName`

Returns
Type	Description
`bool`