Cloud AI Platform v1 API - Class CustomJobName (2.8.0)

Version 2.8.0

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.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

Implements

IResourceName, IEquatable<CustomJobName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
Boolean

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
CustomJobName.ResourceNameType

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
Int32

Overrides

Object.GetHashCode()

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

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	Boolean 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

Object.ToString()

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
Boolean	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, Boolean, 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	Boolean 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
Boolean	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

Equality(CustomJobName, CustomJobName)

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

Parameters
Name	Description
a	CustomJobName
b	CustomJobName

Returns
Type	Description
Boolean

Inequality(CustomJobName, CustomJobName)

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

Parameters
Name	Description
a	CustomJobName
b	CustomJobName

Returns
Type	Description
Boolean