Google Cloud Translation v3 API - Class ExampleName (3.9.0) 

public sealed class ExampleName : IResourceName, IEquatable<ExampleName>

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

Resource name for the Example resource.

Inheritance

object > ExampleName

Namespace

Google.Cloud.Translate.V3

Assembly

Google.Cloud.Translate.V3.dll

Constructors

ExampleName(string, string, string, string)

public ExampleName(string projectId, string locationId, string datasetId, string exampleId)

Constructs a new instance of a ExampleName class from the component parts of pattern projects/{project}/locations/{location}/datasets/{dataset}/examples/{example}

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

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

ExampleId

public string ExampleId { get; }

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

The ExampleName.ResourceNameType of the contained resource name.

Property Value
Type Description
ExampleNameResourceNameType

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

Formats the IDs into the string representation of this ExampleName with pattern projects/{project}/locations/{location}/datasets/{dataset}/examples/{example}.

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

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

The string representation of this ExampleName with pattern projects/{project}/locations/{location}/datasets/{dataset}/examples/{example}.

FormatProjectLocationDatasetExample(string, string, string, string)

public static string FormatProjectLocationDatasetExample(string projectId, string locationId, string datasetId, string exampleId)

Formats the IDs into the string representation of this ExampleName with pattern projects/{project}/locations/{location}/datasets/{dataset}/examples/{example}.

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

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

The string representation of this ExampleName with pattern projects/{project}/locations/{location}/datasets/{dataset}/examples/{example}.

FromProjectLocationDatasetExample(string, string, string, string)

public static ExampleName FromProjectLocationDatasetExample(string projectId, string locationId, string datasetId, string exampleId)

Creates a ExampleName with the pattern projects/{project}/locations/{location}/datasets/{dataset}/examples/{example}.

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

The Example ID. Must not be null or empty.
Returns
Type Description
ExampleName

A new instance of ExampleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ExampleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ExampleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
exampleName string

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

The parsed ExampleName if successful.
Remarks

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

  • projects/{project}/locations/{location}/datasets/{dataset}/examples/{example}

Parse(string, bool)

public static ExampleName Parse(string exampleName, bool allowUnparsed)

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

Parameters
Name Description
exampleName 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
ExampleName

The parsed ExampleName if successful.
Remarks

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

  • projects/{project}/locations/{location}/datasets/{dataset}/examples/{example}
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 ExampleName)

public static bool TryParse(string exampleName, out ExampleName result)

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

Parameters
Name Description
exampleName string

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

When this method returns, the parsed ExampleName, 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}/datasets/{dataset}/examples/{example}

TryParse(string, bool, out ExampleName)

public static bool TryParse(string exampleName, bool allowUnparsed, out ExampleName result)

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

Parameters
Name Description
exampleName 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 ExampleName

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

Operators

operator ==(ExampleName, ExampleName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ExampleName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ExampleName

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

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.