Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Web Security Scanner v1 API - Class FindingName (2.2.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()

Object.MemberwiseClone()

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
`Boolean`

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
`FindingName.ResourceNameType`

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
`Int32`

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

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`	`Boolean` 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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(FindingName, FindingName)

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

Parameters
Name	Description
`a`	`FindingName`
`b`	`FindingName`

Returns
Type	Description
`Boolean`

Inequality(FindingName, FindingName)

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

Parameters
Name	Description
`a`	`FindingName`
`b`	`FindingName`

Returns
Type	Description
`Boolean`