Google Cloud Deploy v1 API - Class DeployPolicyName (3.4.0) 

public sealed class DeployPolicyName : IResourceName, IEquatable<DeployPolicyName>

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

Resource name for the DeployPolicy resource.

Inheritance

object > DeployPolicyName

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

DeployPolicyName(string, string, string)

public DeployPolicyName(string projectId, string locationId, string deployPolicyId)

Constructs a new instance of a DeployPolicyName class from the component parts of pattern projects/{project}/locations/{location}/deployPolicies/{deploy_policy}

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.
deployPolicyId string

The DeployPolicy ID. Must not be null or empty.

Properties

DeployPolicyId

public string DeployPolicyId { get; }

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

The DeployPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
DeployPolicyNameResourceNameType

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

Formats the IDs into the string representation of this DeployPolicyName with pattern projects/{project}/locations/{location}/deployPolicies/{deploy_policy}.

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.
deployPolicyId string

The DeployPolicy ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DeployPolicyName with pattern projects/{project}/locations/{location}/deployPolicies/{deploy_policy}.

FormatProjectLocationDeployPolicy(string, string, string)

public static string FormatProjectLocationDeployPolicy(string projectId, string locationId, string deployPolicyId)

Formats the IDs into the string representation of this DeployPolicyName with pattern projects/{project}/locations/{location}/deployPolicies/{deploy_policy}.

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.
deployPolicyId string

The DeployPolicy ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DeployPolicyName with pattern projects/{project}/locations/{location}/deployPolicies/{deploy_policy}.

FromProjectLocationDeployPolicy(string, string, string)

public static DeployPolicyName FromProjectLocationDeployPolicy(string projectId, string locationId, string deployPolicyId)

Creates a DeployPolicyName with the pattern projects/{project}/locations/{location}/deployPolicies/{deploy_policy}.

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.
deployPolicyId string

The DeployPolicy ID. Must not be null or empty.
Returns
Type Description
DeployPolicyName

A new instance of DeployPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DeployPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DeployPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DeployPolicyName

A new instance of DeployPolicyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static DeployPolicyName Parse(string deployPolicyName)

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

Parameter
Name Description
deployPolicyName string

The resource name in string form. Must not be null.
Returns
Type Description
DeployPolicyName

The parsed DeployPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/deployPolicies/{deploy_policy}

Parse(string, bool)

public static DeployPolicyName Parse(string deployPolicyName, bool allowUnparsed)

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

Parameters
Name Description
deployPolicyName 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
DeployPolicyName

The parsed DeployPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/deployPolicies/{deploy_policy}
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

TryParse(string, out DeployPolicyName)

public static bool TryParse(string deployPolicyName, out DeployPolicyName result)

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

Parameters
Name Description
deployPolicyName string

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

When this method returns, the parsed DeployPolicyName, 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}/deployPolicies/{deploy_policy}

TryParse(string, bool, out DeployPolicyName)

public static bool TryParse(string deployPolicyName, bool allowUnparsed, out DeployPolicyName result)

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

Parameters
Name Description
deployPolicyName 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 DeployPolicyName

When this method returns, the parsed DeployPolicyName, 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}/deployPolicies/{deploy_policy}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DeployPolicyName, DeployPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DeployPolicyName

The first resource name to compare, or null.
b DeployPolicyName

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 !=(DeployPolicyName, DeployPolicyName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DeployPolicyName

The first resource name to compare, or null.
b DeployPolicyName

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.