Google Cloud Data Loss Prevention v2 API - Class FindingName (4.2.0)

Version 4.2.0

• 4.15.0 (latest)
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 2.16.0
• 2.15.0

public sealed class FindingName : IResourceName, IEquatable<FindingName>

Reference documentation and code samples for the Google Cloud Data Loss Prevention v2 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.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

FindingName(String, String, String)

public FindingName(string projectId, string locationId, string findingId)

Constructs a new instance of a FindingName class from the component parts of pattern projects/{project}/locations/{location}/findings/{finding}

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.
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

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
String

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

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)

public static string Format(string projectId, string locationId, string findingId)

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

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.
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}/locations/{location}/findings/{finding}.

FormatProjectLocationFinding(String, String, String)

public static string FormatProjectLocationFinding(string projectId, string locationId, string findingId)

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

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.
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}/locations/{location}/findings/{finding}.

FromProjectLocationFinding(String, String, String)

public static FindingName FromProjectLocationFinding(string projectId, string locationId, string findingId)

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

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.
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}/locations/{location}/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}/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

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}/locations/{location}/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}/locations/{location}/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