Transcoder v1 API - Class JobTemplateName (2.4.0) 

public sealed class JobTemplateName : IResourceName, IEquatable<JobTemplateName>

Reference documentation and code samples for the Transcoder v1 API class JobTemplateName.

Resource name for the JobTemplate resource.

Inheritance

object > JobTemplateName

Namespace

GoogleGoogle.CloudGoogle.Cloud.VideoGoogle.Cloud.Video.TranscoderV1

Assembly

Google.Cloud.Video.Transcoder.V1.dll

Constructors

JobTemplateName(string, string, string)

public JobTemplateName(string projectId, string locationId, string jobTemplateId)

Constructs a new instance of a JobTemplateName class from the component parts of pattern projects/{project}/locations/{location}/jobTemplates/{job_template}

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

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

JobTemplateId

public string JobTemplateId { get; }

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

Property Value
Type Description
string

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 JobTemplateName.ResourceNameType Type { get; }

The JobTemplateName.ResourceNameType of the contained resource name.

Property Value
Type Description
JobTemplateNameResourceNameType

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

Formats the IDs into the string representation of this JobTemplateName with pattern projects/{project}/locations/{location}/jobTemplates/{job_template}.

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

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

The string representation of this JobTemplateName with pattern projects/{project}/locations/{location}/jobTemplates/{job_template}.

FormatProjectLocationJobTemplate(string, string, string)

public static string FormatProjectLocationJobTemplate(string projectId, string locationId, string jobTemplateId)

Formats the IDs into the string representation of this JobTemplateName with pattern projects/{project}/locations/{location}/jobTemplates/{job_template}.

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

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

The string representation of this JobTemplateName with pattern projects/{project}/locations/{location}/jobTemplates/{job_template}.

FromProjectLocationJobTemplate(string, string, string)

public static JobTemplateName FromProjectLocationJobTemplate(string projectId, string locationId, string jobTemplateId)

Creates a JobTemplateName with the pattern projects/{project}/locations/{location}/jobTemplates/{job_template}.

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

The JobTemplate ID. Must not be null or empty.
Returns
Type Description
JobTemplateName

A new instance of JobTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static JobTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a JobTemplateName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
jobTemplateName string

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

The parsed JobTemplateName if successful.
Remarks

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

  • projects/{project}/locations/{location}/jobTemplates/{job_template}

Parse(string, bool)

public static JobTemplateName Parse(string jobTemplateName, bool allowUnparsed)

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

Parameters
Name Description
jobTemplateName 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
JobTemplateName

The parsed JobTemplateName if successful.
Remarks

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

  • projects/{project}/locations/{location}/jobTemplates/{job_template}
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 JobTemplateName)

public static bool TryParse(string jobTemplateName, out JobTemplateName result)

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

Parameters
Name Description
jobTemplateName string

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

When this method returns, the parsed JobTemplateName, 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}/jobTemplates/{job_template}

TryParse(string, bool, out JobTemplateName)

public static bool TryParse(string jobTemplateName, bool allowUnparsed, out JobTemplateName result)

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

Parameters
Name Description
jobTemplateName 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 JobTemplateName

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

Operators

operator ==(JobTemplateName, JobTemplateName)

public static bool operator ==(JobTemplateName a, JobTemplateName b)
Parameters
Name Description
a JobTemplateName
b JobTemplateName
Returns
Type Description
bool

operator !=(JobTemplateName, JobTemplateName)

public static bool operator !=(JobTemplateName a, JobTemplateName b)
Parameters
Name Description
a JobTemplateName
b JobTemplateName
Returns
Type Description
bool