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.
Namespace
Google.Cloud.Deploy.V1Assembly
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 | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
deliveryPipelineId | string The |
releaseId | string The |
rolloutId | string The |
jobRunId | string The |
Properties
DeliveryPipelineId
public string DeliveryPipelineId { get; }
The DeliveryPipeline
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 |
bool |
JobRunId
public string JobRunId { get; }
The JobRun
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
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 |
ReleaseId
public string ReleaseId { get; }
The Release
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
RolloutId
public string RolloutId { get; }
The Rollout
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Type
public JobRunName.ResourceNameType Type { get; }
The JobRunName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
JobRunNameResourceNameType |
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, 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 | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
deliveryPipelineId | string The |
releaseId | string The |
rolloutId | string The |
jobRunId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this JobRunName with pattern
|
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 | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
deliveryPipelineId | string The |
releaseId | string The |
rolloutId | string The |
jobRunId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this JobRunName with pattern
|
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 | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
deliveryPipelineId | string The |
releaseId | string The |
rolloutId | string The |
jobRunId | string The |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
JobRunName | A new instance of JobRunName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static JobRunName Parse(string jobRunName)
Parses the given resource name string into a new JobRunName instance.
Parameter | |
---|---|
Name | Description |
jobRunName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
JobRunName | The parsed JobRunName if successful. |
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, bool)
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 | |
---|---|
Name | Description |
jobRunName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
JobRunName | The parsed JobRunName if successful. |
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}
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. |
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 | |
---|---|
Name | Description |
jobRunName | string The resource name in string form. Must not be |
result | JobRunName When this method returns, the parsed JobRunName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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, bool, 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 | |
---|---|
Name | Description |
jobRunName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | JobRunName When this method returns, the parsed JobRunName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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}
allowUnparsed
is true
.
Operators
operator ==(JobRunName, JobRunName)
public static bool operator ==(JobRunName a, JobRunName b)
Parameters | |
---|---|
Name | Description |
a | JobRunName |
b | JobRunName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(JobRunName, JobRunName)
public static bool operator !=(JobRunName a, JobRunName b)
Parameters | |
---|---|
Name | Description |
a | JobRunName |
b | JobRunName |
Returns | |
---|---|
Type | Description |
bool |