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

public sealed class FrameworkComplianceReportName : IResourceName, IEquatable<FrameworkComplianceReportName>

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

Resource name for the FrameworkComplianceReport resource.

Inheritance

object > FrameworkComplianceReportName

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

FrameworkComplianceReportName(string, string, string)

public FrameworkComplianceReportName(string projectId, string locationId, string frameworkComplianceReportId)

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

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.

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

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 FrameworkComplianceReportName.ResourceNameType Type { get; }

The FrameworkComplianceReportName.ResourceNameType of the contained resource name.

Property Value
Type Description
FrameworkComplianceReportNameResourceNameType

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

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

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.
Returns
Type Description
string

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

FormatFolderLocationFrameworkComplianceReport(string, string, string)

public static string FormatFolderLocationFrameworkComplianceReport(string folderId, string locationId, string frameworkComplianceReportId)

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

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.
Returns
Type Description
string

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

FormatOrganizationLocationFrameworkComplianceReport(string, string, string)

public static string FormatOrganizationLocationFrameworkComplianceReport(string organizationId, string locationId, string frameworkComplianceReportId)

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

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.
Returns
Type Description
string

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

FormatProjectLocationFrameworkComplianceReport(string, string, string)

public static string FormatProjectLocationFrameworkComplianceReport(string projectId, string locationId, string frameworkComplianceReportId)

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

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.
Returns
Type Description
string

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

FromFolderLocationFrameworkComplianceReport(string, string, string)

public static FrameworkComplianceReportName FromFolderLocationFrameworkComplianceReport(string folderId, string locationId, string frameworkComplianceReportId)

Creates a FrameworkComplianceReportName with the pattern folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}.

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.
Returns
Type Description
FrameworkComplianceReportName

A new instance of FrameworkComplianceReportName constructed from the provided ids.

FromOrganizationLocationFrameworkComplianceReport(string, string, string)

public static FrameworkComplianceReportName FromOrganizationLocationFrameworkComplianceReport(string organizationId, string locationId, string frameworkComplianceReportId)

Creates a FrameworkComplianceReportName with the pattern organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report} .

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.
Returns
Type Description
FrameworkComplianceReportName

A new instance of FrameworkComplianceReportName constructed from the provided ids.

FromProjectLocationFrameworkComplianceReport(string, string, string)

public static FrameworkComplianceReportName FromProjectLocationFrameworkComplianceReport(string projectId, string locationId, string frameworkComplianceReportId)

Creates a FrameworkComplianceReportName with the pattern projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}.

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.
Returns
Type Description
FrameworkComplianceReportName

A new instance of FrameworkComplianceReportName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FrameworkComplianceReportName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FrameworkComplianceReportName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
frameworkComplianceReportName string

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

The parsed FrameworkComplianceReportName 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}
  • folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}
  • organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}

Parse(string, bool)

public static FrameworkComplianceReportName Parse(string frameworkComplianceReportName, bool allowUnparsed)

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

Parameters
Name Description
frameworkComplianceReportName 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
FrameworkComplianceReportName

The parsed FrameworkComplianceReportName 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}
  • folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}
  • organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}
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 FrameworkComplianceReportName)

public static bool TryParse(string frameworkComplianceReportName, out FrameworkComplianceReportName result)

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

Parameters
Name Description
frameworkComplianceReportName string

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

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

TryParse(string, bool, out FrameworkComplianceReportName)

public static bool TryParse(string frameworkComplianceReportName, bool allowUnparsed, out FrameworkComplianceReportName result)

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

Parameters
Name Description
frameworkComplianceReportName 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 FrameworkComplianceReportName

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

Operators

operator ==(FrameworkComplianceReportName, FrameworkComplianceReportName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FrameworkComplianceReportName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FrameworkComplianceReportName

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

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.