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

Version latest

• 1.0.0-beta04 (latest)
• 1.0.0-beta03

public sealed class FindingSummaryName : IResourceName, IEquatable<FindingSummaryName>

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

Resource name for the FindingSummary resource.

Inheritance

object > FindingSummaryName

Implements

IResourceName, IEquatableFindingSummaryName

Inherited Members

object.GetType()

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

FindingSummaryName(string, string, string)

public FindingSummaryName(string projectId, string locationId, string findingSummaryId)

Constructs a new instance of a FindingSummaryName class from the component parts of pattern projects/{project}/locations/{location}/findingSummaries/{finding_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.
findingSummaryId	string The FindingSummary ID. Must not be null or empty.

Properties

FindingSummaryId

public string FindingSummaryId { get; }

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

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

The FindingSummaryName.ResourceNameType of the contained resource name.

Property Value
Type	Description
FindingSummaryNameResourceNameType

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

Formats the IDs into the string representation of this FindingSummaryName with pattern projects/{project}/locations/{location}/findingSummaries/{finding_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.
findingSummaryId	string The FindingSummary ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this FindingSummaryName with pattern projects/{project}/locations/{location}/findingSummaries/{finding_summary}.

FormatFolderLocationFindingSummary(string, string, string)

public static string FormatFolderLocationFindingSummary(string folderId, string locationId, string findingSummaryId)

Formats the IDs into the string representation of this FindingSummaryName with pattern folders/{folder}/locations/{location}/findingSummaries/{finding_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.
findingSummaryId	string The FindingSummary ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this FindingSummaryName with pattern folders/{folder}/locations/{location}/findingSummaries/{finding_summary}.

FormatOrganizationLocationFindingSummary(string, string, string)

public static string FormatOrganizationLocationFindingSummary(string organizationId, string locationId, string findingSummaryId)

Formats the IDs into the string representation of this FindingSummaryName with pattern organizations/{organization}/locations/{location}/findingSummaries/{finding_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.
findingSummaryId	string The FindingSummary ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this FindingSummaryName with pattern organizations/{organization}/locations/{location}/findingSummaries/{finding_summary}.

FormatProjectLocationFindingSummary(string, string, string)

public static string FormatProjectLocationFindingSummary(string projectId, string locationId, string findingSummaryId)

Formats the IDs into the string representation of this FindingSummaryName with pattern projects/{project}/locations/{location}/findingSummaries/{finding_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.
findingSummaryId	string The FindingSummary ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this FindingSummaryName with pattern projects/{project}/locations/{location}/findingSummaries/{finding_summary}.

FromFolderLocationFindingSummary(string, string, string)

public static FindingSummaryName FromFolderLocationFindingSummary(string folderId, string locationId, string findingSummaryId)

Creates a FindingSummaryName with the pattern folders/{folder}/locations/{location}/findingSummaries/{finding_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.
findingSummaryId	string The FindingSummary ID. Must not be null or empty.

Returns
Type	Description
FindingSummaryName	A new instance of FindingSummaryName constructed from the provided ids.

FromOrganizationLocationFindingSummary(string, string, string)

public static FindingSummaryName FromOrganizationLocationFindingSummary(string organizationId, string locationId, string findingSummaryId)

Creates a FindingSummaryName with the pattern organizations/{organization}/locations/{location}/findingSummaries/{finding_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.
findingSummaryId	string The FindingSummary ID. Must not be null or empty.

Returns
Type	Description
FindingSummaryName	A new instance of FindingSummaryName constructed from the provided ids.

FromProjectLocationFindingSummary(string, string, string)

public static FindingSummaryName FromProjectLocationFindingSummary(string projectId, string locationId, string findingSummaryId)

Creates a FindingSummaryName with the pattern projects/{project}/locations/{location}/findingSummaries/{finding_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.
findingSummaryId	string The FindingSummary ID. Must not be null or empty.

Returns
Type	Description
FindingSummaryName	A new instance of FindingSummaryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FindingSummaryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FindingSummaryName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
FindingSummaryName	A new instance of FindingSummaryName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static FindingSummaryName Parse(string findingSummaryName)

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

Parameter
Name	Description
findingSummaryName	string The resource name in string form. Must not be null.

Returns
Type	Description
FindingSummaryName	The parsed FindingSummaryName if successful.

Remarks

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

• projects/{project}/locations/{location}/findingSummaries/{finding_summary}
• folders/{folder}/locations/{location}/findingSummaries/{finding_summary}
• organizations/{organization}/locations/{location}/findingSummaries/{finding_summary}

Parse(string, bool)

public static FindingSummaryName Parse(string findingSummaryName, bool allowUnparsed)

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

Parameters
Name	Description
findingSummaryName	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
FindingSummaryName	The parsed FindingSummaryName if successful.

Remarks

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

• projects/{project}/locations/{location}/findingSummaries/{finding_summary}
• folders/{folder}/locations/{location}/findingSummaries/{finding_summary}
• organizations/{organization}/locations/{location}/findingSummaries/{finding_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

object.ToString()

TryParse(string, out FindingSummaryName)

public static bool TryParse(string findingSummaryName, out FindingSummaryName result)

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

Parameters
Name	Description
findingSummaryName	string The resource name in string form. Must not be null.
result	FindingSummaryName When this method returns, the parsed FindingSummaryName, 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}/findingSummaries/{finding_summary}
• folders/{folder}/locations/{location}/findingSummaries/{finding_summary}
• organizations/{organization}/locations/{location}/findingSummaries/{finding_summary}

TryParse(string, bool, out FindingSummaryName)

public static bool TryParse(string findingSummaryName, bool allowUnparsed, out FindingSummaryName result)

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

Parameters
Name	Description
findingSummaryName	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	FindingSummaryName When this method returns, the parsed FindingSummaryName, 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}/findingSummaries/{finding_summary}
• folders/{folder}/locations/{location}/findingSummaries/{finding_summary}
• organizations/{organization}/locations/{location}/findingSummaries/{finding_summary}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FindingSummaryName, FindingSummaryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	FindingSummaryName The first resource name to compare, or null.
b	FindingSummaryName 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 !=(FindingSummaryName, FindingSummaryName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	FindingSummaryName The first resource name to compare, or null.
b	FindingSummaryName 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.