Web Security Scanner v1 API - Class FindingName (2.3.0)

public sealed class FindingName : IResourceName, IEquatable<FindingName>

Reference documentation and code samples for the Web Security Scanner v1 API class FindingName.

Resource name for the Finding resource.

Inheritance

object > FindingName

Implements

IResourceName, IEquatable FindingName

Inherited Members

object.GetType()

Namespace

Google.Cloud.WebSecurityScanner.V1

Assembly

Google.Cloud.WebSecurityScanner.V1.dll

Constructors

FindingName(string, string, string, string)

public FindingName(string projectId, string scanConfigId, string scanRunId, string findingId)

Constructs a new instance of a FindingName class from the component parts of pattern projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`scanConfigId`	`string` The `ScanConfig` ID. Must not be `null` or empty.
`scanRunId`	`string` The `ScanRun` 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. Will not be null, unless this instance contains an unparsed resource name.

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`

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

ScanConfigId

public string ScanConfigId { get; }

The ScanConfig ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

ScanRunId

public string ScanRunId { get; }

The ScanRun ID. Will not be null, unless this instance contains an unparsed resource name.

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

public static string Format(string projectId, string scanConfigId, string scanRunId, string findingId)

Formats the IDs into the string representation of this FindingName with pattern projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`scanConfigId`	`string` The `ScanConfig` ID. Must not be `null` or empty.
`scanRunId`	`string` The `ScanRun` 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}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding}`.

FormatProjectScanConfigScanRunFinding(string, string, string, string)

public static string FormatProjectScanConfigScanRunFinding(string projectId, string scanConfigId, string scanRunId, string findingId)

Formats the IDs into the string representation of this FindingName with pattern projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`scanConfigId`	`string` The `ScanConfig` ID. Must not be `null` or empty.
`scanRunId`	`string` The `ScanRun` 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}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding}`.

FromProjectScanConfigScanRunFinding(string, string, string, string)

public static FindingName FromProjectScanConfigScanRunFinding(string projectId, string scanConfigId, string scanRunId, string findingId)

Creates a FindingName with the pattern projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`scanConfigId`	`string` The `ScanConfig` ID. Must not be `null` or empty.
`scanRunId`	`string` The `ScanRun` 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

object.GetHashCode()

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:

projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/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:

projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/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

object.ToString()

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:

projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/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:

projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/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.