Google Cloud Translation v3 API - Class AdaptiveMtFileName (3.4.0)

public sealed class AdaptiveMtFileName : IResourceName, IEquatable<AdaptiveMtFileName>

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

Resource name for the AdaptiveMtFile resource.

Inheritance

object > AdaptiveMtFileName

Implements

IResourceName, IEquatable AdaptiveMtFileName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Translate.V3

Assembly

Google.Cloud.Translate.V3.dll

Constructors

AdaptiveMtFileName(string, string, string, string)

public AdaptiveMtFileName(string projectId, string locationId, string datasetId, string fileId)

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

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.

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`

Type

public AdaptiveMtFileName.ResourceNameType Type { get; }

The AdaptiveMtFileName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AdaptiveMtFileNameResourceNameType`

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

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

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.

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

FormatProjectLocationDatasetFile(string, string, string, string)

public static string FormatProjectLocationDatasetFile(string projectId, string locationId, string datasetId, string fileId)

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

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.

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

FromProjectLocationDatasetFile(string, string, string, string)

public static AdaptiveMtFileName FromProjectLocationDatasetFile(string projectId, string locationId, string datasetId, string fileId)

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

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.

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

FromUnparsed(UnparsedResourceName)

public static AdaptiveMtFileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AdaptiveMtFileName containing an unparsed resource name.

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

Returns
Type	Description
`AdaptiveMtFileName`	A new instance of AdaptiveMtFileName 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 AdaptiveMtFileName Parse(string adaptiveMtFileName)

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

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

Returns
Type	Description
`AdaptiveMtFileName`	The parsed AdaptiveMtFileName 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}

Parse(string, bool)

public static AdaptiveMtFileName Parse(string adaptiveMtFileName, bool allowUnparsed)

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

Parameters
Name	Description
`adaptiveMtFileName`	`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
`AdaptiveMtFileName`	The parsed AdaptiveMtFileName 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}

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

public static bool TryParse(string adaptiveMtFileName, out AdaptiveMtFileName result)

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

Parameters
Name	Description
`adaptiveMtFileName`	`string` The resource name in string form. Must not be `null`.
`result`	`AdaptiveMtFileName` When this method returns, the parsed AdaptiveMtFileName, 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}

TryParse(string, bool, out AdaptiveMtFileName)

public static bool TryParse(string adaptiveMtFileName, bool allowUnparsed, out AdaptiveMtFileName result)

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

Parameters
Name	Description
`adaptiveMtFileName`	`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`	`AdaptiveMtFileName` When this method returns, the parsed AdaptiveMtFileName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AdaptiveMtFileName, AdaptiveMtFileName)

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

Parameters
Name	Description
`a`	`AdaptiveMtFileName`
`b`	`AdaptiveMtFileName`

Returns
Type	Description
`bool`

operator !=(AdaptiveMtFileName, AdaptiveMtFileName)

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

Parameters
Name	Description
`a`	`AdaptiveMtFileName`
`b`	`AdaptiveMtFileName`

Returns
Type	Description
`bool`