Infrastructure Manager v1 API - Class DeploymentGroupName (1.12.0)

1.12.0 (latest) 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0

public sealed class DeploymentGroupName : IResourceName, IEquatable<DeploymentGroupName>

Reference documentation and code samples for the Infrastructure Manager v1 API class DeploymentGroupName.

Resource name for the DeploymentGroup resource.

Inheritance

object > DeploymentGroupName

Implements

IResourceName, IEquatableDeploymentGroupName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Constructors

DeploymentGroupName(string, string, string)

public DeploymentGroupName(string projectId, string locationId, string deploymentGroupId)

Constructs a new instance of a DeploymentGroupName class from the component parts of pattern projects/{project}/locations/{location}/deploymentGroups/{deployment_group}

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

Properties

DeploymentGroupId

public string DeploymentGroupId { get; }

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

The DeploymentGroupName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DeploymentGroupNameResourceNameType

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

Formats the IDs into the string representation of this DeploymentGroupName with pattern projects/{project}/locations/{location}/deploymentGroups/{deployment_group}.

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

Returns
Type	Description
string	The string representation of this DeploymentGroupName with pattern projects/{project}/locations/{location}/deploymentGroups/{deployment_group}.

FormatProjectLocationDeploymentGroup(string, string, string)

public static string FormatProjectLocationDeploymentGroup(string projectId, string locationId, string deploymentGroupId)

Formats the IDs into the string representation of this DeploymentGroupName with pattern projects/{project}/locations/{location}/deploymentGroups/{deployment_group}.

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

Returns
Type	Description
string	The string representation of this DeploymentGroupName with pattern projects/{project}/locations/{location}/deploymentGroups/{deployment_group}.

FromProjectLocationDeploymentGroup(string, string, string)

public static DeploymentGroupName FromProjectLocationDeploymentGroup(string projectId, string locationId, string deploymentGroupId)

Creates a DeploymentGroupName with the pattern projects/{project}/locations/{location}/deploymentGroups/{deployment_group}.

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

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

FromUnparsed(UnparsedResourceName)

public static DeploymentGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DeploymentGroupName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
DeploymentGroupName	The parsed DeploymentGroupName if successful.

Remarks

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

• projects/{project}/locations/{location}/deploymentGroups/{deployment_group}

Parse(string, bool)

public static DeploymentGroupName Parse(string deploymentGroupName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/deploymentGroups/{deployment_group}

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

public static bool TryParse(string deploymentGroupName, out DeploymentGroupName result)

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

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

TryParse(string, bool, out DeploymentGroupName)

public static bool TryParse(string deploymentGroupName, bool allowUnparsed, out DeploymentGroupName result)

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

Parameters
Name	Description
deploymentGroupName	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	DeploymentGroupName When this method returns, the parsed DeploymentGroupName, 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}/deploymentGroups/{deployment_group}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DeploymentGroupName, DeploymentGroupName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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