Google Cloud Data Loss Prevention v2 API - Class DlpContentName (4.2.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, IEquatable<DlpContentName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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

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

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

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

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`	`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
`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
`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}/dlpContent
projects/{project}/locations/{location}/dlpContent

TryParse(String, Boolean, 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`	`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`	`DlpContentName` When this method returns, the parsed DlpContentName, 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}/dlpContent
projects/{project}/locations/{location}/dlpContent

Or may be in any format if allowUnparsed is true.

Operators

Equality(DlpContentName, DlpContentName)

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

Parameters
Name	Description
`a`	`DlpContentName`
`b`	`DlpContentName`

Returns
Type	Description
`Boolean`

Inequality(DlpContentName, DlpContentName)

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

Parameters
Name	Description
`a`	`DlpContentName`
`b`	`DlpContentName`

Returns
Type	Description
`Boolean`