Google Cloud Deploy v1 API - Class AutomationRunName (3.2.0)

public sealed class AutomationRunName : IResourceName, IEquatable<AutomationRunName>

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

Resource name for the AutomationRun resource.

Inheritance

object > AutomationRunName

Implements

IResourceName, IEquatable AutomationRunName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

AutomationRunName(string, string, string, string)

public AutomationRunName(string projectId, string locationId, string deliveryPipelineId, string automationRunId)

Constructs a new instance of a AutomationRunName class from the component parts of pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}

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.
`deliveryPipelineId`	`string` The `DeliveryPipeline` ID. Must not be `null` or empty.
`automationRunId`	`string` The `AutomationRun` ID. Must not be `null` or empty.

Properties

AutomationRunId

public string AutomationRunId { get; }

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

Property Value
Type	Description
`string`

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`

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`

Type

public AutomationRunName.ResourceNameType Type { get; }

The AutomationRunName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AutomationRunNameResourceNameType`

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)

public static string Format(string projectId, string locationId, string deliveryPipelineId, string automationRunId)

Formats the IDs into the string representation of this AutomationRunName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run} .

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.
`deliveryPipelineId`	`string` The `DeliveryPipeline` ID. Must not be `null` or empty.
`automationRunId`	`string` The `AutomationRun` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AutomationRunName with pattern `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}` .

FormatProjectLocationDeliveryPipelineAutomationRun(string, string, string, string)

public static string FormatProjectLocationDeliveryPipelineAutomationRun(string projectId, string locationId, string deliveryPipelineId, string automationRunId)

Formats the IDs into the string representation of this AutomationRunName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run} .

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.
`deliveryPipelineId`	`string` The `DeliveryPipeline` ID. Must not be `null` or empty.
`automationRunId`	`string` The `AutomationRun` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AutomationRunName with pattern `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}` .

FromProjectLocationDeliveryPipelineAutomationRun(string, string, string, string)

public static AutomationRunName FromProjectLocationDeliveryPipelineAutomationRun(string projectId, string locationId, string deliveryPipelineId, string automationRunId)

Creates a AutomationRunName with the pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run} .

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.
`deliveryPipelineId`	`string` The `DeliveryPipeline` ID. Must not be `null` or empty.
`automationRunId`	`string` The `AutomationRun` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static AutomationRunName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AutomationRunName containing an unparsed resource name.

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

Returns
Type	Description
`AutomationRunName`	A new instance of AutomationRunName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static AutomationRunName Parse(string automationRunName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}

Parse(string, bool)

public static AutomationRunName Parse(string automationRunName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}

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

public static bool TryParse(string automationRunName, out AutomationRunName result)

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

Parameters
Name	Description
`automationRunName`	`string` The resource name in string form. Must not be `null`.
`result`	`AutomationRunName` When this method returns, the parsed AutomationRunName, 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}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}

TryParse(string, bool, out AutomationRunName)

public static bool TryParse(string automationRunName, bool allowUnparsed, out AutomationRunName result)

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

Parameters
Name	Description
`automationRunName`	`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`	`AutomationRunName` When this method returns, the parsed AutomationRunName, 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}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AutomationRunName, AutomationRunName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`AutomationRunName` The first resource name to compare, or null.
`b`	`AutomationRunName` 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 !=(AutomationRunName, AutomationRunName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`AutomationRunName` The first resource name to compare, or null.
`b`	`AutomationRunName` 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.