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

public sealed class FrameworkComplianceSummaryName : IResourceName, IEquatable<FrameworkComplianceSummaryName>

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

Resource name for the FrameworkComplianceSummary resource.

Inheritance

object > FrameworkComplianceSummaryName

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

FrameworkComplianceSummaryName(string, string, string)

public FrameworkComplianceSummaryName(string projectId, string locationId, string frameworkComplianceSummaryId)

Constructs a new instance of a FrameworkComplianceSummaryName class from the component parts of pattern projects/{project}/locations/{location}/frameworkComplianceSummaries/{framework_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.
frameworkComplianceSummaryId string

The FrameworkComplianceSummary ID. Must not be null or empty.

Properties

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

FrameworkComplianceSummaryId

public string FrameworkComplianceSummaryId { get; }

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

The FrameworkComplianceSummaryName.ResourceNameType of the contained resource name.

Property Value
Type Description
FrameworkComplianceSummaryNameResourceNameType

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

Formats the IDs into the string representation of this FrameworkComplianceSummaryName with pattern projects/{project}/locations/{location}/frameworkComplianceSummaries/{framework_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.
frameworkComplianceSummaryId string

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

The string representation of this FrameworkComplianceSummaryName with pattern projects/{project}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}.

FormatFolderLocationFrameworkComplianceSummary(string, string, string)

public static string FormatFolderLocationFrameworkComplianceSummary(string folderId, string locationId, string frameworkComplianceSummaryId)

Formats the IDs into the string representation of this FrameworkComplianceSummaryName with pattern folders/{folder}/locations/{location}/frameworkComplianceSummaries/{framework_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.
frameworkComplianceSummaryId string

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

The string representation of this FrameworkComplianceSummaryName with pattern folders/{folder}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}.

FormatOrganizationLocationFrameworkComplianceSummary(string, string, string)

public static string FormatOrganizationLocationFrameworkComplianceSummary(string organizationId, string locationId, string frameworkComplianceSummaryId)

Formats the IDs into the string representation of this FrameworkComplianceSummaryName with pattern organizations/{organization}/locations/{location}/frameworkComplianceSummaries/{framework_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.
frameworkComplianceSummaryId string

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

The string representation of this FrameworkComplianceSummaryName with pattern organizations/{organization}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary} .

FormatProjectLocationFrameworkComplianceSummary(string, string, string)

public static string FormatProjectLocationFrameworkComplianceSummary(string projectId, string locationId, string frameworkComplianceSummaryId)

Formats the IDs into the string representation of this FrameworkComplianceSummaryName with pattern projects/{project}/locations/{location}/frameworkComplianceSummaries/{framework_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.
frameworkComplianceSummaryId string

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

The string representation of this FrameworkComplianceSummaryName with pattern projects/{project}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}.

FromFolderLocationFrameworkComplianceSummary(string, string, string)

public static FrameworkComplianceSummaryName FromFolderLocationFrameworkComplianceSummary(string folderId, string locationId, string frameworkComplianceSummaryId)

Creates a FrameworkComplianceSummaryName with the pattern folders/{folder}/locations/{location}/frameworkComplianceSummaries/{framework_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.
frameworkComplianceSummaryId string

The FrameworkComplianceSummary ID. Must not be null or empty.
Returns
Type Description
FrameworkComplianceSummaryName

A new instance of FrameworkComplianceSummaryName constructed from the provided ids.

FromOrganizationLocationFrameworkComplianceSummary(string, string, string)

public static FrameworkComplianceSummaryName FromOrganizationLocationFrameworkComplianceSummary(string organizationId, string locationId, string frameworkComplianceSummaryId)

Creates a FrameworkComplianceSummaryName with the pattern organizations/{organization}/locations/{location}/frameworkComplianceSummaries/{framework_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.
frameworkComplianceSummaryId string

The FrameworkComplianceSummary ID. Must not be null or empty.
Returns
Type Description
FrameworkComplianceSummaryName

A new instance of FrameworkComplianceSummaryName constructed from the provided ids.

FromProjectLocationFrameworkComplianceSummary(string, string, string)

public static FrameworkComplianceSummaryName FromProjectLocationFrameworkComplianceSummary(string projectId, string locationId, string frameworkComplianceSummaryId)

Creates a FrameworkComplianceSummaryName with the pattern projects/{project}/locations/{location}/frameworkComplianceSummaries/{framework_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.
frameworkComplianceSummaryId string

The FrameworkComplianceSummary ID. Must not be null or empty.
Returns
Type Description
FrameworkComplianceSummaryName

A new instance of FrameworkComplianceSummaryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FrameworkComplianceSummaryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FrameworkComplianceSummaryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
frameworkComplianceSummaryName string

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

The parsed FrameworkComplianceSummaryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}
  • folders/{folder}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}
  • organizations/{organization}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}

Parse(string, bool)

public static FrameworkComplianceSummaryName Parse(string frameworkComplianceSummaryName, bool allowUnparsed)

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

Parameters
Name Description
frameworkComplianceSummaryName 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
FrameworkComplianceSummaryName

The parsed FrameworkComplianceSummaryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}
  • folders/{folder}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}
  • organizations/{organization}/locations/{location}/frameworkComplianceSummaries/{framework_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 FrameworkComplianceSummaryName)

public static bool TryParse(string frameworkComplianceSummaryName, out FrameworkComplianceSummaryName result)

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

Parameters
Name Description
frameworkComplianceSummaryName string

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

When this method returns, the parsed FrameworkComplianceSummaryName, 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}/frameworkComplianceSummaries/{framework_compliance_summary}
  • folders/{folder}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}
  • organizations/{organization}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}

TryParse(string, bool, out FrameworkComplianceSummaryName)

public static bool TryParse(string frameworkComplianceSummaryName, bool allowUnparsed, out FrameworkComplianceSummaryName result)

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

Parameters
Name Description
frameworkComplianceSummaryName 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 FrameworkComplianceSummaryName

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

Operators

operator ==(FrameworkComplianceSummaryName, FrameworkComplianceSummaryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FrameworkComplianceSummaryName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FrameworkComplianceSummaryName

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

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.