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

public sealed class CloudControlName : IResourceName, IEquatable<CloudControlName>

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

Resource name for the CloudControl resource.

Inheritance

object > CloudControlName

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

CloudControlName(string, string, string)

public CloudControlName(string organizationId, string locationId, string cloudControlId)

Constructs a new instance of a CloudControlName class from the component parts of pattern organizations/{organization}/locations/{location}/cloudControls/{cloud_control}

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

The CloudControl ID. Must not be null or empty.

Properties

CloudControlId

public string CloudControlId { get; }

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

The CloudControlName.ResourceNameType of the contained resource name.

Property Value
Type Description
CloudControlNameResourceNameType

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

Formats the IDs into the string representation of this CloudControlName with pattern organizations/{organization}/locations/{location}/cloudControls/{cloud_control}.

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

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

The string representation of this CloudControlName with pattern organizations/{organization}/locations/{location}/cloudControls/{cloud_control}.

FormatOrganizationLocationCloudControl(string, string, string)

public static string FormatOrganizationLocationCloudControl(string organizationId, string locationId, string cloudControlId)

Formats the IDs into the string representation of this CloudControlName with pattern organizations/{organization}/locations/{location}/cloudControls/{cloud_control}.

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

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

The string representation of this CloudControlName with pattern organizations/{organization}/locations/{location}/cloudControls/{cloud_control}.

FromOrganizationLocationCloudControl(string, string, string)

public static CloudControlName FromOrganizationLocationCloudControl(string organizationId, string locationId, string cloudControlId)

Creates a CloudControlName with the pattern organizations/{organization}/locations/{location}/cloudControls/{cloud_control}.

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

The CloudControl ID. Must not be null or empty.
Returns
Type Description
CloudControlName

A new instance of CloudControlName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CloudControlName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CloudControlName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
cloudControlName string

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

The parsed CloudControlName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/cloudControls/{cloud_control}

Parse(string, bool)

public static CloudControlName Parse(string cloudControlName, bool allowUnparsed)

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

Parameters
Name Description
cloudControlName 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
CloudControlName

The parsed CloudControlName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/cloudControls/{cloud_control}
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 CloudControlName)

public static bool TryParse(string cloudControlName, out CloudControlName result)

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

Parameters
Name Description
cloudControlName string

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

When this method returns, the parsed CloudControlName, 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}/cloudControls/{cloud_control}

TryParse(string, bool, out CloudControlName)

public static bool TryParse(string cloudControlName, bool allowUnparsed, out CloudControlName result)

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

Parameters
Name Description
cloudControlName 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 CloudControlName

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

Operators

operator ==(CloudControlName, CloudControlName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CloudControlName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CloudControlName

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

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.