Google Cloud Data Loss Prevention v2 API - Class JobTriggerName (4.5.0)

public sealed class JobTriggerName : IResourceName, IEquatable<JobTriggerName>

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

Resource name for the JobTrigger resource.

Inheritance

Object > JobTriggerName

Implements

IResourceName, IEquatable<JobTriggerName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

JobTriggerName(String, String)

public JobTriggerName(string projectId, string jobTriggerId)

Constructs a new instance of a JobTriggerName class from the component parts of pattern projects/{project}/jobTriggers/{job_trigger}

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`jobTriggerId`	`String` The `JobTrigger` 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`

JobTriggerId

public string JobTriggerId { get; }

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

Property Value
Type	Description
`String`

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

The JobTriggerName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`JobTriggerName.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)

public static string Format(string projectId, string jobTriggerId)

Formats the IDs into the string representation of this JobTriggerName with pattern projects/{project}/jobTriggers/{job_trigger}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`jobTriggerId`	`String` The `JobTrigger` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this JobTriggerName with pattern `projects/{project}/jobTriggers/{job_trigger}`.

FormatProjectJobTrigger(String, String)

public static string FormatProjectJobTrigger(string projectId, string jobTriggerId)

Formats the IDs into the string representation of this JobTriggerName with pattern projects/{project}/jobTriggers/{job_trigger}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`jobTriggerId`	`String` The `JobTrigger` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this JobTriggerName with pattern `projects/{project}/jobTriggers/{job_trigger}`.

FormatProjectLocationJobTrigger(String, String, String)

public static string FormatProjectLocationJobTrigger(string projectId, string locationId, string jobTriggerId)

Formats the IDs into the string representation of this JobTriggerName with pattern projects/{project}/locations/{location}/jobTriggers/{job_trigger}.

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.
`jobTriggerId`	`String` The `JobTrigger` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this JobTriggerName with pattern `projects/{project}/locations/{location}/jobTriggers/{job_trigger}`.

FromProjectJobTrigger(String, String)

public static JobTriggerName FromProjectJobTrigger(string projectId, string jobTriggerId)

Creates a JobTriggerName with the pattern projects/{project}/jobTriggers/{job_trigger}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`jobTriggerId`	`String` The `JobTrigger` ID. Must not be `null` or empty.

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

FromProjectLocationJobTrigger(String, String, String)

public static JobTriggerName FromProjectLocationJobTrigger(string projectId, string locationId, string jobTriggerId)

Creates a JobTriggerName with the pattern projects/{project}/locations/{location}/jobTriggers/{job_trigger}.

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.
`jobTriggerId`	`String` The `JobTrigger` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static JobTriggerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a JobTriggerName containing an unparsed resource name.

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

Returns
Type	Description
`JobTriggerName`	A new instance of JobTriggerName 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 JobTriggerName Parse(string jobTriggerName)

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

Parameter
Name	Description
`jobTriggerName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`JobTriggerName`	The parsed JobTriggerName if successful.

Remarks

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

projects/{project}/jobTriggers/{job_trigger}
projects/{project}/locations/{location}/jobTriggers/{job_trigger}

Parse(String, Boolean)

public static JobTriggerName Parse(string jobTriggerName, bool allowUnparsed)

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

Parameters
Name	Description
`jobTriggerName`	`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
`JobTriggerName`	The parsed JobTriggerName if successful.

Remarks

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

projects/{project}/jobTriggers/{job_trigger}
projects/{project}/locations/{location}/jobTriggers/{job_trigger}

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

public static bool TryParse(string jobTriggerName, out JobTriggerName result)

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

Parameters
Name	Description
`jobTriggerName`	`String` The resource name in string form. Must not be `null`.
`result`	`JobTriggerName` When this method returns, the parsed JobTriggerName, 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}/jobTriggers/{job_trigger}
projects/{project}/locations/{location}/jobTriggers/{job_trigger}

TryParse(String, Boolean, out JobTriggerName)

public static bool TryParse(string jobTriggerName, bool allowUnparsed, out JobTriggerName result)

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

Parameters
Name	Description
`jobTriggerName`	`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`	`JobTriggerName` When this method returns, the parsed JobTriggerName, 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}/jobTriggers/{job_trigger}
projects/{project}/locations/{location}/jobTriggers/{job_trigger}

Or may be in any format if allowUnparsed is true.

Operators

Equality(JobTriggerName, JobTriggerName)

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

Parameters
Name	Description
`a`	`JobTriggerName`
`b`	`JobTriggerName`

Returns
Type	Description
`Boolean`

Inequality(JobTriggerName, JobTriggerName)

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

Parameters
Name	Description
`a`	`JobTriggerName`
`b`	`JobTriggerName`

Returns
Type	Description
`Boolean`