Google Cloud Data Loss Prevention v2 API - Class DlpContentName (2.15.0)

Version 2.15.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 DlpContentName : IResourceName, IEquatable<DlpContentName>

Reference documentation and code samples for the Google Cloud Data Loss Prevention v2 API class DlpContentName.

Resource name for the DlpContent resource.

Inheritance

object > DlpContentName

Implements

IResourceName, IEquatableDlpContentName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

DlpContentName(string)

public DlpContentName(string projectId)

Constructs a new instance of a DlpContentName class from the component parts of pattern projects/{project}/dlpContent

Parameter
Name	Description
projectId	string The Project ID. Must not be null or empty.

Properties

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

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

The DlpContentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DlpContentNameResourceNameType

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)

public static string Format(string projectId)

Formats the IDs into the string representation of this DlpContentName with pattern projects/{project}/dlpContent.

Parameter
Name	Description
projectId	string The Project ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DlpContentName with pattern projects/{project}/dlpContent .

FormatProject(string)

public static string FormatProject(string projectId)

Formats the IDs into the string representation of this DlpContentName with pattern projects/{project}/dlpContent.

Parameter
Name	Description
projectId	string The Project ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DlpContentName with pattern projects/{project}/dlpContent .

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this DlpContentName with pattern projects/{project}/locations/{location}/dlpContent.

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.

Returns
Type	Description
string	The string representation of this DlpContentName with pattern projects/{project}/locations/{location}/dlpContent.

FromProject(string)

public static DlpContentName FromProject(string projectId)

Creates a DlpContentName with the pattern projects/{project}/dlpContent.

Parameter
Name	Description
projectId	string The Project ID. Must not be null or empty.

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

FromProjectLocation(string, string)

public static DlpContentName FromProjectLocation(string projectId, string locationId)

Creates a DlpContentName with the pattern projects/{project}/locations/{location}/dlpContent.

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.

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

FromUnparsed(UnparsedResourceName)

public static DlpContentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DlpContentName containing an unparsed resource name.

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

Returns
Type	Description
DlpContentName	A new instance of DlpContentName 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 DlpContentName Parse(string dlpContentName)

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

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

Returns
Type	Description
DlpContentName	The parsed DlpContentName if successful.

Remarks

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

• projects/{project}/dlpContent
• projects/{project}/locations/{location}/dlpContent

Parse(string, bool)

public static DlpContentName Parse(string dlpContentName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/dlpContent
• projects/{project}/locations/{location}/dlpContent

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

public static bool TryParse(string dlpContentName, out DlpContentName result)

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

Parameters
Name	Description
dlpContentName	string The resource name in string form. Must not be null.
result	DlpContentName When this method returns, the parsed DlpContentName, 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}/dlpContent
• projects/{project}/locations/{location}/dlpContent

TryParse(string, bool, out DlpContentName)

public static bool TryParse(string dlpContentName, bool allowUnparsed, out DlpContentName result)

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

Parameters
Name	Description
dlpContentName	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	DlpContentName When this method returns, the parsed DlpContentName, 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}/dlpContent
• projects/{project}/locations/{location}/dlpContent

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DlpContentName, DlpContentName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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