Cloud Dataplex v1 API - Class MetadataJobName (3.12.0)

Version latest

• 3.12.0 (latest)
• 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.15.0
• 2.14.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
• 2.1.0
• 2.0.0
• 1.0.0

public sealed class MetadataJobName : IResourceName, IEquatable<MetadataJobName>

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

Resource name for the MetadataJob resource.

Inheritance

object > MetadataJobName

Implements

IResourceName, IEquatableMetadataJobName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

MetadataJobName(string, string, string)

public MetadataJobName(string projectId, string locationId, string metadataJobId)

Constructs a new instance of a MetadataJobName class from the component parts of pattern projects/{project}/locations/{location}/metadataJobs/{metadataJob}

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.
metadataJobId	string The MetadataJob 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
bool

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

MetadataJobId

public string MetadataJobId { get; }

The MetadataJob 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 MetadataJobName.ResourceNameType Type { get; }

The MetadataJobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
MetadataJobNameResourceNameType

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)

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

Formats the IDs into the string representation of this MetadataJobName with pattern projects/{project}/locations/{location}/metadataJobs/{metadataJob}.

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.
metadataJobId	string The MetadataJob ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this MetadataJobName with pattern projects/{project}/locations/{location}/metadataJobs/{metadataJob}.

FormatProjectLocationMetadataJob(string, string, string)

public static string FormatProjectLocationMetadataJob(string projectId, string locationId, string metadataJobId)

Formats the IDs into the string representation of this MetadataJobName with pattern projects/{project}/locations/{location}/metadataJobs/{metadataJob}.

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.
metadataJobId	string The MetadataJob ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this MetadataJobName with pattern projects/{project}/locations/{location}/metadataJobs/{metadataJob}.

FromProjectLocationMetadataJob(string, string, string)

public static MetadataJobName FromProjectLocationMetadataJob(string projectId, string locationId, string metadataJobId)

Creates a MetadataJobName with the pattern projects/{project}/locations/{location}/metadataJobs/{metadataJob}.

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.
metadataJobId	string The MetadataJob ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static MetadataJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MetadataJobName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
MetadataJobName	The parsed MetadataJobName if successful.

Remarks

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

• projects/{project}/locations/{location}/metadataJobs/{metadataJob}

Parse(string, bool)

public static MetadataJobName Parse(string metadataJobName, bool allowUnparsed)

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

Parameters
Name	Description
metadataJobName	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
MetadataJobName	The parsed MetadataJobName if successful.

Remarks

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

• projects/{project}/locations/{location}/metadataJobs/{metadataJob}

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

public static bool TryParse(string metadataJobName, out MetadataJobName result)

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

Parameters
Name	Description
metadataJobName	string The resource name in string form. Must not be null.
result	MetadataJobName When this method returns, the parsed MetadataJobName, 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}/metadataJobs/{metadataJob}

TryParse(string, bool, out MetadataJobName)

public static bool TryParse(string metadataJobName, bool allowUnparsed, out MetadataJobName result)

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

Parameters
Name	Description
metadataJobName	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	MetadataJobName When this method returns, the parsed MetadataJobName, 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}/metadataJobs/{metadataJob}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MetadataJobName, MetadataJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	MetadataJobName The first resource name to compare, or null.
b	MetadataJobName The second resource name to compare, or null.

Returns
Type	Description
bool	true if the value of a is the same as the value of b; otherwise, false.

operator !=(MetadataJobName, MetadataJobName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	MetadataJobName The first resource name to compare, or null.
b	MetadataJobName The second resource name to compare, or null.

Returns
Type	Description
bool	true if the value of a is different from the value of b; otherwise, false.