Google Cloud Deploy v1 API - Class AutomationName (2.13.0)

Version 2.13.0

• 3.4.0 (latest)
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

public sealed class AutomationName : IResourceName, IEquatable<AutomationName>

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

Resource name for the Automation resource.

Inheritance

object > AutomationName

Implements

IResourceName, IEquatableAutomationName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

AutomationName(string, string, string, string)

public AutomationName(string projectId, string locationId, string deliveryPipelineId, string automationId)

Constructs a new instance of a AutomationName class from the component parts of pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}

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.
automationId	string The Automation ID. Must not be null or empty.

Properties

AutomationId

public string AutomationId { get; }

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

The AutomationName.ResourceNameType of the contained resource name.

Property Value
Type	Description
AutomationNameResourceNameType

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

Formats the IDs into the string representation of this AutomationName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation} .

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.
automationId	string The Automation ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this AutomationName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation} .

FormatProjectLocationDeliveryPipelineAutomation(string, string, string, string)

public static string FormatProjectLocationDeliveryPipelineAutomation(string projectId, string locationId, string deliveryPipelineId, string automationId)

Formats the IDs into the string representation of this AutomationName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation} .

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.
automationId	string The Automation ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this AutomationName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation} .

FromProjectLocationDeliveryPipelineAutomation(string, string, string, string)

public static AutomationName FromProjectLocationDeliveryPipelineAutomation(string projectId, string locationId, string deliveryPipelineId, string automationId)

Creates a AutomationName with the pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation} .

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.
automationId	string The Automation ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static AutomationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AutomationName containing an unparsed resource name.

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

Returns
Type	Description
AutomationName	A new instance of AutomationName 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 AutomationName Parse(string automationName)

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

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

Returns
Type	Description
AutomationName	The parsed AutomationName if successful.

Remarks

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

• projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}

Parse(string, bool)

public static AutomationName Parse(string automationName, bool allowUnparsed)

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

Parameters
Name	Description
automationName	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
AutomationName	The parsed AutomationName if successful.

Remarks

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

• projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}

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

public static bool TryParse(string automationName, out AutomationName result)

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

Parameters
Name	Description
automationName	string The resource name in string form. Must not be null.
result	AutomationName When this method returns, the parsed AutomationName, 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}/automations/{automation}

TryParse(string, bool, out AutomationName)

public static bool TryParse(string automationName, bool allowUnparsed, out AutomationName result)

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

Parameters
Name	Description
automationName	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	AutomationName When this method returns, the parsed AutomationName, 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}/automations/{automation}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AutomationName, AutomationName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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