Cloud AI Platform v1beta1 API - Class NasJobName (1.0.0-beta09) 

public sealed class NasJobName : IResourceName, IEquatable<NasJobName>

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class NasJobName.

Resource name for the NasJob resource.

Inheritance

object > NasJobName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

NasJobName(string, string, string)

public NasJobName(string projectId, string locationId, string nasJobId)

Constructs a new instance of a NasJobName class from the component parts of pattern projects/{project}/locations/{location}/nasJobs/{nas_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.
nasJobId string

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

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

NasJobId

public string NasJobId { get; }

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

The NasJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
NasJobNameResourceNameType

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

Formats the IDs into the string representation of this NasJobName with pattern projects/{project}/locations/{location}/nasJobs/{nas_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.
nasJobId string

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

The string representation of this NasJobName with pattern projects/{project}/locations/{location}/nasJobs/{nas_job}.

FormatProjectLocationNasJob(string, string, string)

public static string FormatProjectLocationNasJob(string projectId, string locationId, string nasJobId)

Formats the IDs into the string representation of this NasJobName with pattern projects/{project}/locations/{location}/nasJobs/{nas_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.
nasJobId string

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

The string representation of this NasJobName with pattern projects/{project}/locations/{location}/nasJobs/{nas_job}.

FromProjectLocationNasJob(string, string, string)

public static NasJobName FromProjectLocationNasJob(string projectId, string locationId, string nasJobId)

Creates a NasJobName with the pattern projects/{project}/locations/{location}/nasJobs/{nas_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.
nasJobId string

The NasJob ID. Must not be null or empty.
Returns
Type Description
NasJobName

A new instance of NasJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NasJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NasJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
nasJobName string

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

The parsed NasJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/nasJobs/{nas_job}

Parse(string, bool)

public static NasJobName Parse(string nasJobName, bool allowUnparsed)

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

Parameters
Name Description
nasJobName 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
NasJobName

The parsed NasJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/nasJobs/{nas_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 NasJobName)

public static bool TryParse(string nasJobName, out NasJobName result)

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

Parameters
Name Description
nasJobName string

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

When this method returns, the parsed NasJobName, 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}/nasJobs/{nas_job}

TryParse(string, bool, out NasJobName)

public static bool TryParse(string nasJobName, bool allowUnparsed, out NasJobName result)

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

Parameters
Name Description
nasJobName 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 NasJobName

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

Operators

operator ==(NasJobName, NasJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a NasJobName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a NasJobName

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

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.