Google Cloud Security Command Center v1 API - Class DlpJobName (3.10.0)

Version 3.10.0

• 3.24.0 (latest)
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0

public sealed class DlpJobName : IResourceName, IEquatable<DlpJobName>

Reference documentation and code samples for the Google Cloud Security Command Center v1 API class DlpJobName.

Resource name for the DlpJob resource.

Inheritance

object > DlpJobName

Implements

IResourceName, IEquatableDlpJobName

Inherited Members

object.GetType()

Namespace

Google.Cloud.SecurityCenter.V1

Assembly

Google.Cloud.SecurityCenter.V1.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
Name	Description
projectId	string The Project ID. Must not be null or empty.
dlpJobId	string 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
Type	Description
string

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

The DlpJobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DlpJobNameResourceNameType

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)

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
Name	Description
projectId	string The Project ID. Must not be null or empty.
dlpJobId	string The DlpJob ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	string The Project ID. Must not be null or empty.
dlpJobId	string The DlpJob ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
dlpJobId	string The DlpJob ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	string The Project ID. Must not be null or empty.
dlpJobId	string The DlpJob ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
dlpJobId	string The DlpJob ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

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

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

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

Returns
Type	Description
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, bool)

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
Name	Description
dlpJobName	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
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
Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

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

TryParse(string, bool, 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
Name	Description
dlpJobName	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	DlpJobName When this method returns, the parsed DlpJobName, 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}/dlpJobs/{dlp_job}
• projects/{project}/locations/{location}/dlpJobs/{dlp_job}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DlpJobName, DlpJobName)

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

Parameters
Name	Description
a	DlpJobName
b	DlpJobName

Returns
Type	Description
bool

operator !=(DlpJobName, DlpJobName)

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

Parameters
Name	Description
a	DlpJobName
b	DlpJobName

Returns
Type	Description
bool