Google Cloud Deploy v1 API - Class JobRunName (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class JobRunName : IResourceName, IEquatable<JobRunName>

Reference documentation and code samples for the Google Cloud Deploy v1 API class JobRunName.

Resource name for the JobRun resource.

Inheritance

Object > JobRunName

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

JobRunName(String, String, String, String, String, String)

public JobRunName(string projectId, string locationId, string deliveryPipelineId, string releaseId, string rolloutId, string jobRunId)

Constructs a new instance of a JobRunName class from the component parts of pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

deliveryPipelineIdString

The DeliveryPipeline ID. Must not be null or empty.

releaseIdString

The Release ID. Must not be null or empty.

rolloutIdString

The Rollout ID. Must not be null or empty.

jobRunIdString

The JobRun ID. Must not be null or empty.

Properties

DeliveryPipelineId

public string DeliveryPipelineId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

JobRunId

public string JobRunId { get; }

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

Property Value
TypeDescription
String

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

ReleaseId

public string ReleaseId { get; }

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

Property Value
TypeDescription
String

RolloutId

public string RolloutId { get; }

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

Property Value
TypeDescription
String

Type

public JobRunName.ResourceNameType Type { get; }

The JobRunName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
JobRunName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String, String, String, String)

public static string Format(string projectId, string locationId, string deliveryPipelineId, string releaseId, string rolloutId, string jobRunId)

Formats the IDs into the string representation of this JobRunName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

deliveryPipelineIdString

The DeliveryPipeline ID. Must not be null or empty.

releaseIdString

The Release ID. Must not be null or empty.

rolloutIdString

The Rollout ID. Must not be null or empty.

jobRunIdString

The JobRun ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this JobRunName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run} .

FormatProjectLocationDeliveryPipelineReleaseRolloutJobRun(String, String, String, String, String, String)

public static string FormatProjectLocationDeliveryPipelineReleaseRolloutJobRun(string projectId, string locationId, string deliveryPipelineId, string releaseId, string rolloutId, string jobRunId)

Formats the IDs into the string representation of this JobRunName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

deliveryPipelineIdString

The DeliveryPipeline ID. Must not be null or empty.

releaseIdString

The Release ID. Must not be null or empty.

rolloutIdString

The Rollout ID. Must not be null or empty.

jobRunIdString

The JobRun ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this JobRunName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run} .

FromProjectLocationDeliveryPipelineReleaseRolloutJobRun(String, String, String, String, String, String)

public static JobRunName FromProjectLocationDeliveryPipelineReleaseRolloutJobRun(string projectId, string locationId, string deliveryPipelineId, string releaseId, string rolloutId, string jobRunId)

Creates a JobRunName with the pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

deliveryPipelineIdString

The DeliveryPipeline ID. Must not be null or empty.

releaseIdString

The Release ID. Must not be null or empty.

rolloutIdString

The Rollout ID. Must not be null or empty.

jobRunIdString

The JobRun ID. Must not be null or empty.

Returns
TypeDescription
JobRunName

A new instance of JobRunName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static JobRunName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a JobRunName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
JobRunName

A new instance of JobRunName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static JobRunName Parse(string jobRunName)

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

Parameter
NameDescription
jobRunNameString

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

Returns
TypeDescription
JobRunName

The parsed JobRunName if successful.

Remarks

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

  • projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run}

Parse(String, Boolean)

public static JobRunName Parse(string jobRunName, bool allowUnparsed)

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

Parameters
NameDescription
jobRunNameString

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

allowUnparsedBoolean

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
TypeDescription
JobRunName

The parsed JobRunName if successful.

Remarks

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

  • projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out JobRunName)

public static bool TryParse(string jobRunName, out JobRunName result)

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

Parameters
NameDescription
jobRunNameString

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

resultJobRunName

When this method returns, the parsed JobRunName, or null if parsing failed.

Returns
TypeDescription
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}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run}

TryParse(String, Boolean, out JobRunName)

public static bool TryParse(string jobRunName, bool allowUnparsed, out JobRunName result)

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

Parameters
NameDescription
jobRunNameString

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

allowUnparsedBoolean

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.

resultJobRunName

When this method returns, the parsed JobRunName, or null if parsing failed.

Returns
TypeDescription
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}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run}
Or may be in any format if allowUnparsed is true.

Operators

Equality(JobRunName, JobRunName)

public static bool operator ==(JobRunName a, JobRunName b)
Parameters
NameDescription
aJobRunName
bJobRunName
Returns
TypeDescription
Boolean

Inequality(JobRunName, JobRunName)

public static bool operator !=(JobRunName a, JobRunName b)
Parameters
NameDescription
aJobRunName
bJobRunName
Returns
TypeDescription
Boolean