Cloud Security Compliance v1 API - Class CloudControlDeploymentName (1.0.0-beta02) 

public sealed class CloudControlDeploymentName : IResourceName, IEquatable<CloudControlDeploymentName>

Reference documentation and code samples for the Cloud Security Compliance v1 API class CloudControlDeploymentName.

Resource name for the CloudControlDeployment resource.

Inheritance

object > CloudControlDeploymentName

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

CloudControlDeploymentName(string, string, string)

public CloudControlDeploymentName(string organizationId, string locationId, string cloudControlDeploymentId)

Constructs a new instance of a CloudControlDeploymentName class from the component parts of pattern organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
cloudControlDeploymentId string

The CloudControlDeployment ID. Must not be null or empty.

Properties

CloudControlDeploymentId

public string CloudControlDeploymentId { get; }

The CloudControlDeployment 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

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

Type

public CloudControlDeploymentName.ResourceNameType Type { get; }

The CloudControlDeploymentName.ResourceNameType of the contained resource name.

Property Value
Type Description
CloudControlDeploymentNameResourceNameType

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 organizationId, string locationId, string cloudControlDeploymentId)

Formats the IDs into the string representation of this CloudControlDeploymentName with pattern organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
cloudControlDeploymentId string

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

The string representation of this CloudControlDeploymentName with pattern organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}.

FormatOrganizationLocationCloudControlDeployment(string, string, string)

public static string FormatOrganizationLocationCloudControlDeployment(string organizationId, string locationId, string cloudControlDeploymentId)

Formats the IDs into the string representation of this CloudControlDeploymentName with pattern organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
cloudControlDeploymentId string

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

The string representation of this CloudControlDeploymentName with pattern organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}.

FromOrganizationLocationCloudControlDeployment(string, string, string)

public static CloudControlDeploymentName FromOrganizationLocationCloudControlDeployment(string organizationId, string locationId, string cloudControlDeploymentId)

Creates a CloudControlDeploymentName with the pattern organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
cloudControlDeploymentId string

The CloudControlDeployment ID. Must not be null or empty.
Returns
Type Description
CloudControlDeploymentName

A new instance of CloudControlDeploymentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CloudControlDeploymentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CloudControlDeploymentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of CloudControlDeploymentName 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 CloudControlDeploymentName Parse(string cloudControlDeploymentName)

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

Parameter
Name Description
cloudControlDeploymentName string

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

The parsed CloudControlDeploymentName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}

Parse(string, bool)

public static CloudControlDeploymentName Parse(string cloudControlDeploymentName, bool allowUnparsed)

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

Parameters
Name Description
cloudControlDeploymentName 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
CloudControlDeploymentName

The parsed CloudControlDeploymentName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}
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 CloudControlDeploymentName)

public static bool TryParse(string cloudControlDeploymentName, out CloudControlDeploymentName result)

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

Parameters
Name Description
cloudControlDeploymentName string

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

When this method returns, the parsed CloudControlDeploymentName, 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:

  • organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}

TryParse(string, bool, out CloudControlDeploymentName)

public static bool TryParse(string cloudControlDeploymentName, bool allowUnparsed, out CloudControlDeploymentName result)

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

Parameters
Name Description
cloudControlDeploymentName 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 CloudControlDeploymentName

When this method returns, the parsed CloudControlDeploymentName, 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:

  • organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CloudControlDeploymentName, CloudControlDeploymentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CloudControlDeploymentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CloudControlDeploymentName

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

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.