Class TrainingPipelineName (1.2.0)

public sealed class TrainingPipelineName : IResourceName, IEquatable<TrainingPipelineName>

Resource name for the TrainingPipeline resource.

Inheritance

Object > TrainingPipelineName

Implements

IResourceName, IEquatable<TrainingPipelineName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

TrainingPipelineName(String, String, String)

public TrainingPipelineName(string projectId, string locationId, string trainingPipelineId)

Constructs a new instance of a TrainingPipelineName class from the component parts of pattern projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

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.
`trainingPipelineId`	`String` The `TrainingPipeline` 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
`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`

TrainingPipelineId

public string TrainingPipelineId { get; }

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

Property Value
Type	Description
`String`

Type

public TrainingPipelineName.ResourceNameType Type { get; }

The TrainingPipelineName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TrainingPipelineName.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 trainingPipelineId)

Formats the IDs into the string representation of this TrainingPipelineName with pattern projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}.

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.
`trainingPipelineId`	`String` The `TrainingPipeline` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this TrainingPipelineName with pattern `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`.

FormatProjectLocationTrainingPipeline(String, String, String)

public static string FormatProjectLocationTrainingPipeline(string projectId, string locationId, string trainingPipelineId)

Formats the IDs into the string representation of this TrainingPipelineName with pattern projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}.

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.
`trainingPipelineId`	`String` The `TrainingPipeline` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this TrainingPipelineName with pattern `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`.

FromProjectLocationTrainingPipeline(String, String, String)

public static TrainingPipelineName FromProjectLocationTrainingPipeline(string projectId, string locationId, string trainingPipelineId)

Creates a TrainingPipelineName with the pattern projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}.

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.
`trainingPipelineId`	`String` The `TrainingPipeline` ID. Must not be `null` or empty.

Returns
Type	Description
`TrainingPipelineName`	A new instance of TrainingPipelineName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TrainingPipelineName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TrainingPipelineName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`TrainingPipelineName`	A new instance of TrainingPipelineName 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 TrainingPipelineName Parse(string trainingPipelineName)

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

Parameter
Name	Description
`trainingPipelineName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`TrainingPipelineName`	The parsed TrainingPipelineName if successful.

Remarks

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

projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

Parse(String, Boolean)

public static TrainingPipelineName Parse(string trainingPipelineName, bool allowUnparsed)

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

Parameters
Name	Description
`trainingPipelineName`	`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
`TrainingPipelineName`	The parsed TrainingPipelineName if successful.

Remarks

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

projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

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

public static bool TryParse(string trainingPipelineName, out TrainingPipelineName result)

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

Parameters
Name	Description
`trainingPipelineName`	`String` The resource name in string form. Must not be `null`.
`result`	`TrainingPipelineName` When this method returns, the parsed TrainingPipelineName, 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}/trainingPipelines/{training_pipeline}

TryParse(String, Boolean, out TrainingPipelineName)

public static bool TryParse(string trainingPipelineName, bool allowUnparsed, out TrainingPipelineName result)

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

Parameters
Name	Description
`trainingPipelineName`	`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`	`TrainingPipelineName` When this method returns, the parsed TrainingPipelineName, 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}/trainingPipelines/{training_pipeline}

Or may be in any format if allowUnparsed is true.

Operators

Equality(TrainingPipelineName, TrainingPipelineName)

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

Parameters
Name	Description
`a`	`TrainingPipelineName`
`b`	`TrainingPipelineName`

Returns
Type	Description
`Boolean`

Inequality(TrainingPipelineName, TrainingPipelineName)

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

Parameters
Name	Description
`a`	`TrainingPipelineName`
`b`	`TrainingPipelineName`

Returns
Type	Description
`Boolean`