Google Cloud Data Loss Prevention v2 API - Class DlpJobName (4.3.0)

public sealed class DlpJobName : IResourceName, IEquatable<DlpJobName>

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

Resource name for the DlpJob resource.

Inheritance

Object > DlpJobName

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

DlpJobName(String, String)

public DlpJobName(string projectId, string dlpJobId)

Constructs a new instance of a DlpJobName class from the component parts of pattern projects/{project}/dlpJobs/{dlp_job}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

dlpJobIdString

The DlpJob ID. Must not be null or empty.

Properties

DlpJobId

public string DlpJobId { get; }

The DlpJob ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

Type

public DlpJobName.ResourceNameType Type { get; }

The DlpJobName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DlpJobName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String)

public static string Format(string projectId, string dlpJobId)

Formats the IDs into the string representation of this DlpJobName with pattern projects/{project}/dlpJobs/{dlp_job}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

dlpJobIdString

The DlpJob ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this DlpJobName with pattern projects/{project}/dlpJobs/{dlp_job}.

FormatProjectDlpJob(String, String)

public static string FormatProjectDlpJob(string projectId, string dlpJobId)

Formats the IDs into the string representation of this DlpJobName with pattern projects/{project}/dlpJobs/{dlp_job}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

dlpJobIdString

The DlpJob ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this DlpJobName with pattern projects/{project}/dlpJobs/{dlp_job}.

FormatProjectLocationDlpJob(String, String, String)

public static string FormatProjectLocationDlpJob(string projectId, string locationId, string dlpJobId)

Formats the IDs into the string representation of this DlpJobName with pattern projects/{project}/locations/{location}/dlpJobs/{dlp_job}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

dlpJobIdString

The DlpJob ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this DlpJobName with pattern projects/{project}/locations/{location}/dlpJobs/{dlp_job}.

FromProjectDlpJob(String, String)

public static DlpJobName FromProjectDlpJob(string projectId, string dlpJobId)

Creates a DlpJobName with the pattern projects/{project}/dlpJobs/{dlp_job}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

dlpJobIdString

The DlpJob ID. Must not be null or empty.

Returns
TypeDescription
DlpJobName

A new instance of DlpJobName constructed from the provided ids.

FromProjectLocationDlpJob(String, String, String)

public static DlpJobName FromProjectLocationDlpJob(string projectId, string locationId, string dlpJobId)

Creates a DlpJobName with the pattern projects/{project}/locations/{location}/dlpJobs/{dlp_job}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

dlpJobIdString

The DlpJob ID. Must not be null or empty.

Returns
TypeDescription
DlpJobName

A new instance of DlpJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DlpJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DlpJobName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DlpJobName

A new instance of DlpJobName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static DlpJobName Parse(string dlpJobName)

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

Parameter
NameDescription
dlpJobNameString

The resource name in string form. Must not be null.

Returns
TypeDescription
DlpJobName

The parsed DlpJobName if successful.

Remarks

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

  • projects/{project}/dlpJobs/{dlp_job}
  • projects/{project}/locations/{location}/dlpJobs/{dlp_job}

Parse(String, Boolean)

public static DlpJobName Parse(string dlpJobName, bool allowUnparsed)

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

Parameters
NameDescription
dlpJobNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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
TypeDescription
DlpJobName

The parsed DlpJobName if successful.

Remarks

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

  • projects/{project}/dlpJobs/{dlp_job}
  • projects/{project}/locations/{location}/dlpJobs/{dlp_job}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out DlpJobName)

public static bool TryParse(string dlpJobName, out DlpJobName result)

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

Parameters
NameDescription
dlpJobNameString

The resource name in string form. Must not be null.

resultDlpJobName

When this method returns, the parsed DlpJobName, or null if parsing failed.

Returns
TypeDescription
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}/dlpJobs/{dlp_job}
  • projects/{project}/locations/{location}/dlpJobs/{dlp_job}

TryParse(String, Boolean, out DlpJobName)

public static bool TryParse(string dlpJobName, bool allowUnparsed, out DlpJobName result)

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

Parameters
NameDescription
dlpJobNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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.

resultDlpJobName

When this method returns, the parsed DlpJobName, or null if parsing failed.

Returns
TypeDescription
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}/dlpJobs/{dlp_job}
  • projects/{project}/locations/{location}/dlpJobs/{dlp_job}
Or may be in any format if allowUnparsed is true.

Operators

Equality(DlpJobName, DlpJobName)

public static bool operator ==(DlpJobName a, DlpJobName b)
Parameters
NameDescription
aDlpJobName
bDlpJobName
Returns
TypeDescription
Boolean

Inequality(DlpJobName, DlpJobName)

public static bool operator !=(DlpJobName a, DlpJobName b)
Parameters
NameDescription
aDlpJobName
bDlpJobName
Returns
TypeDescription
Boolean