Dataproc Metastore v1 API - Class MetadataImportName (2.4.0)

public sealed class MetadataImportName : IResourceName, IEquatable<MetadataImportName>

Reference documentation and code samples for the Dataproc Metastore v1 API class MetadataImportName.

Resource name for the MetadataImport resource.

Inheritance

object > MetadataImportName

Namespace

Google.Cloud.Metastore.V1

Assembly

Google.Cloud.Metastore.V1.dll

Constructors

MetadataImportName(string, string, string, string)

public MetadataImportName(string projectId, string locationId, string serviceId, string metadataImportId)

Constructs a new instance of a MetadataImportName class from the component parts of pattern projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

metadataImportIdstring

The MetadataImport 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
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

MetadataImportId

public string MetadataImportId { get; }

The MetadataImport 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

ServiceId

public string ServiceId { get; }

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

Property Value
TypeDescription
string

Type

public MetadataImportName.ResourceNameType Type { get; }

The MetadataImportName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
MetadataImportNameResourceNameType

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

public static string Format(string projectId, string locationId, string serviceId, string metadataImportId)

Formats the IDs into the string representation of this MetadataImportName with pattern projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

metadataImportIdstring

The MetadataImport ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this MetadataImportName with pattern projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}.

FormatProjectLocationServiceMetadataImport(string, string, string, string)

public static string FormatProjectLocationServiceMetadataImport(string projectId, string locationId, string serviceId, string metadataImportId)

Formats the IDs into the string representation of this MetadataImportName with pattern projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

metadataImportIdstring

The MetadataImport ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this MetadataImportName with pattern projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}.

FromProjectLocationServiceMetadataImport(string, string, string, string)

public static MetadataImportName FromProjectLocationServiceMetadataImport(string projectId, string locationId, string serviceId, string metadataImportId)

Creates a MetadataImportName with the pattern projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

metadataImportIdstring

The MetadataImport ID. Must not be null or empty.

Returns
TypeDescription
MetadataImportName

A new instance of MetadataImportName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MetadataImportName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MetadataImportName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
MetadataImportName

A new instance of MetadataImportName 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 MetadataImportName Parse(string metadataImportName)

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

Parameter
NameDescription
metadataImportNamestring

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

Returns
TypeDescription
MetadataImportName

The parsed MetadataImportName if successful.

Remarks

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

  • projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}

Parse(string, bool)

public static MetadataImportName Parse(string metadataImportName, bool allowUnparsed)

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

Parameters
NameDescription
metadataImportNamestring

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
MetadataImportName

The parsed MetadataImportName if successful.

Remarks

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

  • projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}
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 MetadataImportName)

public static bool TryParse(string metadataImportName, out MetadataImportName result)

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

Parameters
NameDescription
metadataImportNamestring

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

resultMetadataImportName

When this method returns, the parsed MetadataImportName, 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}/services/{service}/metadataImports/{metadata_import}

TryParse(string, bool, out MetadataImportName)

public static bool TryParse(string metadataImportName, bool allowUnparsed, out MetadataImportName result)

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

Parameters
NameDescription
metadataImportNamestring

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.

resultMetadataImportName

When this method returns, the parsed MetadataImportName, 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}/services/{service}/metadataImports/{metadata_import}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(MetadataImportName, MetadataImportName)

public static bool operator ==(MetadataImportName a, MetadataImportName b)
Parameters
NameDescription
aMetadataImportName
bMetadataImportName
Returns
TypeDescription
bool

operator !=(MetadataImportName, MetadataImportName)

public static bool operator !=(MetadataImportName a, MetadataImportName b)
Parameters
NameDescription
aMetadataImportName
bMetadataImportName
Returns
TypeDescription
bool