Security Command Center v2 API - Class FindingName (1.0.0-beta03) 

public sealed class FindingName : IResourceName, IEquatable<FindingName>

Reference documentation and code samples for the Security Command Center v2 API class FindingName.

Resource name for the Finding resource.

Inheritance

object > FindingName

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

FindingName(string, string, string)

public FindingName(string organizationId, string sourceId, string findingId)

Constructs a new instance of a FindingName class from the component parts of pattern organizations/{organization}/sources/{source}/findings/{finding}

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
sourceId string

The Source ID. Must not be null or empty.
findingId string

The Finding ID. Must not be null or empty.

Properties

FindingId

public string FindingId { get; }

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

SourceId

public string SourceId { get; }

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

Property Value
Type Description
string

Type

public FindingName.ResourceNameType Type { get; }

The FindingName.ResourceNameType of the contained resource name.

Property Value
Type Description
FindingNameResourceNameType

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 sourceId, string findingId)

Formats the IDs into the string representation of this FindingName with pattern organizations/{organization}/sources/{source}/findings/{finding}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
sourceId string

The Source ID. Must not be null or empty.
findingId string

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

The string representation of this FindingName with pattern organizations/{organization}/sources/{source}/findings/{finding}.

FormatFolderSourceFinding(string, string, string)

public static string FormatFolderSourceFinding(string folderId, string sourceId, string findingId)

Formats the IDs into the string representation of this FindingName with pattern folders/{folder}/sources/{source}/findings/{finding}.

Parameters
Name Description
folderId string

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

The Source ID. Must not be null or empty.
findingId string

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

The string representation of this FindingName with pattern folders/{folder}/sources/{source}/findings/{finding}.

FormatFolderSourceLocationFinding(string, string, string, string)

public static string FormatFolderSourceLocationFinding(string folderId, string sourceId, string locationId, string findingId)

Formats the IDs into the string representation of this FindingName with pattern folders/{folder}/sources/{source}/locations/{location}/findings/{finding}.

Parameters
Name Description
folderId string

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

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

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

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

The string representation of this FindingName with pattern folders/{folder}/sources/{source}/locations/{location}/findings/{finding}.

FormatOrganizationSourceFinding(string, string, string)

public static string FormatOrganizationSourceFinding(string organizationId, string sourceId, string findingId)

Formats the IDs into the string representation of this FindingName with pattern organizations/{organization}/sources/{source}/findings/{finding}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
sourceId string

The Source ID. Must not be null or empty.
findingId string

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

The string representation of this FindingName with pattern organizations/{organization}/sources/{source}/findings/{finding}.

FormatOrganizationSourceLocationFinding(string, string, string, string)

public static string FormatOrganizationSourceLocationFinding(string organizationId, string sourceId, string locationId, string findingId)

Formats the IDs into the string representation of this FindingName with pattern organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
sourceId string

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

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

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

The string representation of this FindingName with pattern organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}.

FormatProjectSourceFinding(string, string, string)

public static string FormatProjectSourceFinding(string projectId, string sourceId, string findingId)

Formats the IDs into the string representation of this FindingName with pattern projects/{project}/sources/{source}/findings/{finding}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
sourceId string

The Source ID. Must not be null or empty.
findingId string

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

The string representation of this FindingName with pattern projects/{project}/sources/{source}/findings/{finding}.

FormatProjectSourceLocationFinding(string, string, string, string)

public static string FormatProjectSourceLocationFinding(string projectId, string sourceId, string locationId, string findingId)

Formats the IDs into the string representation of this FindingName with pattern projects/{project}/sources/{source}/locations/{location}/findings/{finding}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
sourceId string

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

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

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

The string representation of this FindingName with pattern projects/{project}/sources/{source}/locations/{location}/findings/{finding}.

FromFolderSourceFinding(string, string, string)

public static FindingName FromFolderSourceFinding(string folderId, string sourceId, string findingId)

Creates a FindingName with the pattern folders/{folder}/sources/{source}/findings/{finding} .

Parameters
Name Description
folderId string

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

The Source ID. Must not be null or empty.
findingId string

The Finding ID. Must not be null or empty.
Returns
Type Description
FindingName

A new instance of FindingName constructed from the provided ids.

FromFolderSourceLocationFinding(string, string, string, string)

public static FindingName FromFolderSourceLocationFinding(string folderId, string sourceId, string locationId, string findingId)

Creates a FindingName with the pattern folders/{folder}/sources/{source}/locations/{location}/findings/{finding}.

Parameters
Name Description
folderId string

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

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

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

The Finding ID. Must not be null or empty.
Returns
Type Description
FindingName

A new instance of FindingName constructed from the provided ids.

FromOrganizationSourceFinding(string, string, string)

public static FindingName FromOrganizationSourceFinding(string organizationId, string sourceId, string findingId)

Creates a FindingName with the pattern organizations/{organization}/sources/{source}/findings/{finding}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
sourceId string

The Source ID. Must not be null or empty.
findingId string

The Finding ID. Must not be null or empty.
Returns
Type Description
FindingName

A new instance of FindingName constructed from the provided ids.

FromOrganizationSourceLocationFinding(string, string, string, string)

public static FindingName FromOrganizationSourceLocationFinding(string organizationId, string sourceId, string locationId, string findingId)

Creates a FindingName with the pattern organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
sourceId string

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

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

The Finding ID. Must not be null or empty.
Returns
Type Description
FindingName

A new instance of FindingName constructed from the provided ids.

FromProjectSourceFinding(string, string, string)

public static FindingName FromProjectSourceFinding(string projectId, string sourceId, string findingId)

Creates a FindingName with the pattern projects/{project}/sources/{source}/findings/{finding}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
sourceId string

The Source ID. Must not be null or empty.
findingId string

The Finding ID. Must not be null or empty.
Returns
Type Description
FindingName

A new instance of FindingName constructed from the provided ids.

FromProjectSourceLocationFinding(string, string, string, string)

public static FindingName FromProjectSourceLocationFinding(string projectId, string sourceId, string locationId, string findingId)

Creates a FindingName with the pattern projects/{project}/sources/{source}/locations/{location}/findings/{finding}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
sourceId string

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

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

The Finding ID. Must not be null or empty.
Returns
Type Description
FindingName

A new instance of FindingName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FindingName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FindingName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
findingName string

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

The parsed FindingName if successful.
Remarks

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

  • organizations/{organization}/sources/{source}/findings/{finding}
  • organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}
  • folders/{folder}/sources/{source}/findings/{finding}
  • folders/{folder}/sources/{source}/locations/{location}/findings/{finding}
  • projects/{project}/sources/{source}/findings/{finding}
  • projects/{project}/sources/{source}/locations/{location}/findings/{finding}

Parse(string, bool)

public static FindingName Parse(string findingName, bool allowUnparsed)

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

Parameters
Name Description
findingName 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
FindingName

The parsed FindingName if successful.
Remarks

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

  • organizations/{organization}/sources/{source}/findings/{finding}
  • organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}
  • folders/{folder}/sources/{source}/findings/{finding}
  • folders/{folder}/sources/{source}/locations/{location}/findings/{finding}
  • projects/{project}/sources/{source}/findings/{finding}
  • projects/{project}/sources/{source}/locations/{location}/findings/{finding}
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 FindingName)

public static bool TryParse(string findingName, out FindingName result)

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

Parameters
Name Description
findingName string

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

When this method returns, the parsed FindingName, 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}/sources/{source}/findings/{finding}
  • organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}
  • folders/{folder}/sources/{source}/findings/{finding}
  • folders/{folder}/sources/{source}/locations/{location}/findings/{finding}
  • projects/{project}/sources/{source}/findings/{finding}
  • projects/{project}/sources/{source}/locations/{location}/findings/{finding}

TryParse(string, bool, out FindingName)

public static bool TryParse(string findingName, bool allowUnparsed, out FindingName result)

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

Parameters
Name Description
findingName 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 FindingName

When this method returns, the parsed FindingName, 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}/sources/{source}/findings/{finding}
  • organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}
  • folders/{folder}/sources/{source}/findings/{finding}
  • folders/{folder}/sources/{source}/locations/{location}/findings/{finding}
  • projects/{project}/sources/{source}/findings/{finding}
  • projects/{project}/sources/{source}/locations/{location}/findings/{finding}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FindingName, FindingName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FindingName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FindingName

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

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.