Cloud Dataplex v1 API - Class DataScanName (2.15.0)

public sealed class DataScanName : IResourceName, IEquatable<DataScanName>

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

Resource name for the DataScan resource.

Inheritance

object > DataScanName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataScanName(string, string, string)

public DataScanName(string projectId, string locationId, string dataScanId)

Constructs a new instance of a DataScanName class from the component parts of pattern projects/{project}/locations/{location}/dataScans/{dataScan}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

dataScanIdstring

The DataScan 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
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public DataScanName.ResourceNameType Type { get; }

The DataScanName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DataScanNameResourceNameType

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

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

Formats the IDs into the string representation of this DataScanName with pattern projects/{project}/locations/{location}/dataScans/{dataScan}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

dataScanIdstring

The DataScan ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this DataScanName with pattern projects/{project}/locations/{location}/dataScans/{dataScan}.

FormatProjectLocationDataScan(string, string, string)

public static string FormatProjectLocationDataScan(string projectId, string locationId, string dataScanId)

Formats the IDs into the string representation of this DataScanName with pattern projects/{project}/locations/{location}/dataScans/{dataScan}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

dataScanIdstring

The DataScan ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this DataScanName with pattern projects/{project}/locations/{location}/dataScans/{dataScan}.

FromProjectLocationDataScan(string, string, string)

public static DataScanName FromProjectLocationDataScan(string projectId, string locationId, string dataScanId)

Creates a DataScanName with the pattern projects/{project}/locations/{location}/dataScans/{dataScan}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

dataScanIdstring

The DataScan ID. Must not be null or empty.

Returns
TypeDescription
DataScanName

A new instance of DataScanName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataScanName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataScanName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DataScanName

A new instance of DataScanName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static DataScanName Parse(string dataScanName)

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

Parameter
NameDescription
dataScanNamestring

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

Returns
TypeDescription
DataScanName

The parsed DataScanName if successful.

Remarks

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

  • projects/{project}/locations/{location}/dataScans/{dataScan}

Parse(string, bool)

public static DataScanName Parse(string dataScanName, bool allowUnparsed)

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

Parameters
NameDescription
dataScanNamestring

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

allowUnparsedbool

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
DataScanName

The parsed DataScanName if successful.

Remarks

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

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

public static bool TryParse(string dataScanName, out DataScanName result)

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

Parameters
NameDescription
dataScanNamestring

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

resultDataScanName

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

Returns
TypeDescription
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}

TryParse(string, bool, out DataScanName)

public static bool TryParse(string dataScanName, bool allowUnparsed, out DataScanName result)

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

Parameters
NameDescription
dataScanNamestring

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

allowUnparsedbool

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.

resultDataScanName

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

Returns
TypeDescription
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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataScanName, DataScanName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aDataScanName

The first resource name to compare, or null.

bDataScanName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(DataScanName, DataScanName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aDataScanName

The first resource name to compare, or null.

bDataScanName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.