Cloud AI Platform v1 API - Class CustomJobName (3.7.0) 

public sealed class CustomJobName : IResourceName, IEquatable<CustomJobName>

Reference documentation and code samples for the Cloud AI Platform v1 API class CustomJobName.

Resource name for the CustomJob resource.

Inheritance

object > CustomJobName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

CustomJobName(string, string, string)

public CustomJobName(string projectId, string locationId, string customJobId)

Constructs a new instance of a CustomJobName class from the component parts of pattern projects/{project}/locations/{location}/customJobs/{custom_job}

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

The CustomJob ID. Must not be null or empty.

Properties

CustomJobId

public string CustomJobId { get; }

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

The CustomJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
CustomJobNameResourceNameType

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

Formats the IDs into the string representation of this CustomJobName with pattern projects/{project}/locations/{location}/customJobs/{custom_job}.

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

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

The string representation of this CustomJobName with pattern projects/{project}/locations/{location}/customJobs/{custom_job}.

FormatProjectLocationCustomJob(string, string, string)

public static string FormatProjectLocationCustomJob(string projectId, string locationId, string customJobId)

Formats the IDs into the string representation of this CustomJobName with pattern projects/{project}/locations/{location}/customJobs/{custom_job}.

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

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

The string representation of this CustomJobName with pattern projects/{project}/locations/{location}/customJobs/{custom_job}.

FromProjectLocationCustomJob(string, string, string)

public static CustomJobName FromProjectLocationCustomJob(string projectId, string locationId, string customJobId)

Creates a CustomJobName with the pattern projects/{project}/locations/{location}/customJobs/{custom_job}.

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

The CustomJob ID. Must not be null or empty.
Returns
Type Description
CustomJobName

A new instance of CustomJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CustomJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CustomJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
customJobName string

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

The parsed CustomJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/customJobs/{custom_job}

Parse(string, bool)

public static CustomJobName Parse(string customJobName, bool allowUnparsed)

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

Parameters
Name Description
customJobName 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
CustomJobName

The parsed CustomJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/customJobs/{custom_job}
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 CustomJobName)

public static bool TryParse(string customJobName, out CustomJobName result)

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

Parameters
Name Description
customJobName string

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

When this method returns, the parsed CustomJobName, 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}/customJobs/{custom_job}

TryParse(string, bool, out CustomJobName)

public static bool TryParse(string customJobName, bool allowUnparsed, out CustomJobName result)

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

Parameters
Name Description
customJobName 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 CustomJobName

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

Operators

operator ==(CustomJobName, CustomJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CustomJobName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CustomJobName

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

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.