Cloud AI Platform v1 API - Class PipelineJobName (3.2.0) 

public sealed class PipelineJobName : IResourceName, IEquatable<PipelineJobName>

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

Resource name for the PipelineJob resource.

Inheritance

object > PipelineJobName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

PipelineJobName(string, string, string)

public PipelineJobName(string projectId, string locationId, string pipelineJobId)

Constructs a new instance of a PipelineJobName class from the component parts of pattern projects/{project}/locations/{location}/pipelineJobs/{pipeline_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.
pipelineJobId string

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

PipelineJobId

public string PipelineJobId { get; }

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

The PipelineJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
PipelineJobNameResourceNameType

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

Formats the IDs into the string representation of this PipelineJobName with pattern projects/{project}/locations/{location}/pipelineJobs/{pipeline_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.
pipelineJobId string

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

The string representation of this PipelineJobName with pattern projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}.

FormatProjectLocationPipelineJob(string, string, string)

public static string FormatProjectLocationPipelineJob(string projectId, string locationId, string pipelineJobId)

Formats the IDs into the string representation of this PipelineJobName with pattern projects/{project}/locations/{location}/pipelineJobs/{pipeline_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.
pipelineJobId string

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

The string representation of this PipelineJobName with pattern projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}.

FromProjectLocationPipelineJob(string, string, string)

public static PipelineJobName FromProjectLocationPipelineJob(string projectId, string locationId, string pipelineJobId)

Creates a PipelineJobName with the pattern projects/{project}/locations/{location}/pipelineJobs/{pipeline_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.
pipelineJobId string

The PipelineJob ID. Must not be null or empty.
Returns
Type Description
PipelineJobName

A new instance of PipelineJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PipelineJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PipelineJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
pipelineJobName string

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

The parsed PipelineJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

Parse(string, bool)

public static PipelineJobName Parse(string pipelineJobName, bool allowUnparsed)

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

Parameters
Name Description
pipelineJobName 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
PipelineJobName

The parsed PipelineJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/pipelineJobs/{pipeline_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 PipelineJobName)

public static bool TryParse(string pipelineJobName, out PipelineJobName result)

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

Parameters
Name Description
pipelineJobName string

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

When this method returns, the parsed PipelineJobName, 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}/pipelineJobs/{pipeline_job}

TryParse(string, bool, out PipelineJobName)

public static bool TryParse(string pipelineJobName, bool allowUnparsed, out PipelineJobName result)

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

Parameters
Name Description
pipelineJobName 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 PipelineJobName

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

Operators

operator ==(PipelineJobName, PipelineJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PipelineJobName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PipelineJobName

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

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.