Cloud Security Compliance v1 API - Class ControlComplianceSummaryName (1.0.0-beta04) 

public sealed class ControlComplianceSummaryName : IResourceName, IEquatable<ControlComplianceSummaryName>

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

Resource name for the ControlComplianceSummary resource.

Inheritance

object > ControlComplianceSummaryName

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

ControlComplianceSummaryName(string, string, string, string)

public ControlComplianceSummaryName(string projectId, string locationId, string frameworkComplianceReportId, string controlComplianceSummaryId)

Constructs a new instance of a ControlComplianceSummaryName class from the component parts of pattern projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}

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

The FrameworkComplianceReport ID. Must not be null or empty.
controlComplianceSummaryId string

The ControlComplianceSummary ID. Must not be null or empty.

Properties

ControlComplianceSummaryId

public string ControlComplianceSummaryId { get; }

The ControlComplianceSummary ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

FrameworkComplianceReportId

public string FrameworkComplianceReportId { get; }

The FrameworkComplianceReport ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public ControlComplianceSummaryName.ResourceNameType Type { get; }

The ControlComplianceSummaryName.ResourceNameType of the contained resource name.

Property Value
Type Description
ControlComplianceSummaryNameResourceNameType

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 frameworkComplianceReportId, string controlComplianceSummaryId)

Formats the IDs into the string representation of this ControlComplianceSummaryName with pattern projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

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

The FrameworkComplianceReport ID. Must not be null or empty.
controlComplianceSummaryId string

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

The string representation of this ControlComplianceSummaryName with pattern projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

FormatFolderLocationFrameworkComplianceReportControlComplianceSummary(string, string, string, string)

public static string FormatFolderLocationFrameworkComplianceReportControlComplianceSummary(string folderId, string locationId, string frameworkComplianceReportId, string controlComplianceSummaryId)

Formats the IDs into the string representation of this ControlComplianceSummaryName with pattern folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

Parameters
Name Description
folderId string

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

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

The FrameworkComplianceReport ID. Must not be null or empty.
controlComplianceSummaryId string

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

The string representation of this ControlComplianceSummaryName with pattern folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

FormatOrganizationLocationFrameworkComplianceReportControlComplianceSummary(string, string, string, string)

public static string FormatOrganizationLocationFrameworkComplianceReportControlComplianceSummary(string organizationId, string locationId, string frameworkComplianceReportId, string controlComplianceSummaryId)

Formats the IDs into the string representation of this ControlComplianceSummaryName with pattern organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

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

The FrameworkComplianceReport ID. Must not be null or empty.
controlComplianceSummaryId string

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

The string representation of this ControlComplianceSummaryName with pattern organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

FormatProjectLocationFrameworkComplianceReportControlComplianceSummary(string, string, string, string)

public static string FormatProjectLocationFrameworkComplianceReportControlComplianceSummary(string projectId, string locationId, string frameworkComplianceReportId, string controlComplianceSummaryId)

Formats the IDs into the string representation of this ControlComplianceSummaryName with pattern projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

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

The FrameworkComplianceReport ID. Must not be null or empty.
controlComplianceSummaryId string

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

The string representation of this ControlComplianceSummaryName with pattern projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

FromFolderLocationFrameworkComplianceReportControlComplianceSummary(string, string, string, string)

public static ControlComplianceSummaryName FromFolderLocationFrameworkComplianceReportControlComplianceSummary(string folderId, string locationId, string frameworkComplianceReportId, string controlComplianceSummaryId)

Creates a ControlComplianceSummaryName with the pattern folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

Parameters
Name Description
folderId string

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

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

The FrameworkComplianceReport ID. Must not be null or empty.
controlComplianceSummaryId string

The ControlComplianceSummary ID. Must not be null or empty.
Returns
Type Description
ControlComplianceSummaryName

A new instance of ControlComplianceSummaryName constructed from the provided ids.

FromOrganizationLocationFrameworkComplianceReportControlComplianceSummary(string, string, string, string)

public static ControlComplianceSummaryName FromOrganizationLocationFrameworkComplianceReportControlComplianceSummary(string organizationId, string locationId, string frameworkComplianceReportId, string controlComplianceSummaryId)

Creates a ControlComplianceSummaryName with the pattern organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

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

The FrameworkComplianceReport ID. Must not be null or empty.
controlComplianceSummaryId string

The ControlComplianceSummary ID. Must not be null or empty.
Returns
Type Description
ControlComplianceSummaryName

A new instance of ControlComplianceSummaryName constructed from the provided ids.

FromProjectLocationFrameworkComplianceReportControlComplianceSummary(string, string, string, string)

public static ControlComplianceSummaryName FromProjectLocationFrameworkComplianceReportControlComplianceSummary(string projectId, string locationId, string frameworkComplianceReportId, string controlComplianceSummaryId)

Creates a ControlComplianceSummaryName with the pattern projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary} .

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

The FrameworkComplianceReport ID. Must not be null or empty.
controlComplianceSummaryId string

The ControlComplianceSummary ID. Must not be null or empty.
Returns
Type Description
ControlComplianceSummaryName

A new instance of ControlComplianceSummaryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ControlComplianceSummaryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ControlComplianceSummaryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
controlComplianceSummaryName string

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

The parsed ControlComplianceSummaryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}
  • folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}
  • organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}

Parse(string, bool)

public static ControlComplianceSummaryName Parse(string controlComplianceSummaryName, bool allowUnparsed)

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

Parameters
Name Description
controlComplianceSummaryName 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
ControlComplianceSummaryName

The parsed ControlComplianceSummaryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}
  • folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}
  • organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}
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 ControlComplianceSummaryName)

public static bool TryParse(string controlComplianceSummaryName, out ControlComplianceSummaryName result)

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

Parameters
Name Description
controlComplianceSummaryName string

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

When this method returns, the parsed ControlComplianceSummaryName, 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}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}
  • folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}
  • organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}

TryParse(string, bool, out ControlComplianceSummaryName)

public static bool TryParse(string controlComplianceSummaryName, bool allowUnparsed, out ControlComplianceSummaryName result)

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

Parameters
Name Description
controlComplianceSummaryName 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 ControlComplianceSummaryName

When this method returns, the parsed ControlComplianceSummaryName, 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}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}
  • folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}
  • organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ControlComplianceSummaryName, ControlComplianceSummaryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ControlComplianceSummaryName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ControlComplianceSummaryName

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

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.