Cloud Dataplex v1 API - Class DataScanJobName (2.6.0)

public sealed class DataScanJobName : IResourceName, IEquatable<DataScanJobName>

Reference documentation and code samples for the Cloud Dataplex v1 API class DataScanJobName.

Resource name for the DataScanJob resource.

Inheritance

object > DataScanJobName

Implements

IResourceName, IEquatable DataScanJobName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataScanJobName(string, string, string, string)

public DataScanJobName(string projectId, string locationId, string dataScanId, string jobId)

Constructs a new instance of a DataScanJobName class from the component parts of pattern projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{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.
`dataScanId`	`string` The `DataScan` ID. Must not be `null` or empty.
`jobId`	`string` The `Job` ID. Must not be `null` or empty.

Properties

DataScanId

public string DataScanId { get; }

The DataScan ID. Will not be null, unless this instance contains an unparsed resource name.

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`

JobId

public string JobId { get; }

The Job ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

Type

public DataScanJobName.ResourceNameType Type { get; }

The DataScanJobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`DataScanJobNameResourceNameType`

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

public static string Format(string projectId, string locationId, string dataScanId, string jobId)

Formats the IDs into the string representation of this DataScanJobName with pattern projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{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.
`dataScanId`	`string` The `DataScan` ID. Must not be `null` or empty.
`jobId`	`string` The `Job` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this DataScanJobName with pattern `projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{job}`.

FormatProjectLocationDataScanJob(string, string, string, string)

public static string FormatProjectLocationDataScanJob(string projectId, string locationId, string dataScanId, string jobId)

Formats the IDs into the string representation of this DataScanJobName with pattern projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{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.
`dataScanId`	`string` The `DataScan` ID. Must not be `null` or empty.
`jobId`	`string` The `Job` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this DataScanJobName with pattern `projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{job}`.

FromProjectLocationDataScanJob(string, string, string, string)

public static DataScanJobName FromProjectLocationDataScanJob(string projectId, string locationId, string dataScanId, string jobId)

Creates a DataScanJobName with the pattern projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{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.
`dataScanId`	`string` The `DataScan` ID. Must not be `null` or empty.
`jobId`	`string` The `Job` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static DataScanJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataScanJobName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{job}

Parse(string, bool)

public static DataScanJobName Parse(string dataScanJobName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{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 DataScanJobName)

public static bool TryParse(string dataScanJobName, out DataScanJobName result)

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

Parameters
Name	Description
`dataScanJobName`	`string` The resource name in string form. Must not be `null`.
`result`	`DataScanJobName` When this method returns, the parsed DataScanJobName, 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}/locations/{location}/dataScans/{dataScan}/jobs/{job}

TryParse(string, bool, out DataScanJobName)

public static bool TryParse(string dataScanJobName, bool allowUnparsed, out DataScanJobName result)

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

Parameters
Name	Description
`dataScanJobName`	`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`	`DataScanJobName` When this method returns, the parsed DataScanJobName, 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}/locations/{location}/dataScans/{dataScan}/jobs/{job}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataScanJobName, DataScanJobName)

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

Parameters
Name	Description
`a`	`DataScanJobName`
`b`	`DataScanJobName`

Returns
Type	Description
`bool`

operator !=(DataScanJobName, DataScanJobName)

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

Parameters
Name	Description
`a`	`DataScanJobName`
`b`	`DataScanJobName`

Returns
Type	Description
`bool`