Class MetadataSchemaName

public sealed class MetadataSchemaName : IResourceName, IEquatable<MetadataSchemaName>

Resource name for the MetadataSchema resource.

Inheritance

Object > MetadataSchemaName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

MetadataSchemaName(String, String, String, String)

public MetadataSchemaName(string projectId, string locationId, string metadataStoreId, string metadataSchemaId)

Constructs a new instance of a MetadataSchemaName class from the component parts of pattern projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

metadataStoreIdString

The MetadataStore ID. Must not be null or empty.

metadataSchemaIdString

The MetadataSchema 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
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

MetadataSchemaId

public string MetadataSchemaId { get; }

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

Property Value
TypeDescription
String

MetadataStoreId

public string MetadataStoreId { get; }

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

The MetadataSchemaName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
MetadataSchemaName.ResourceNameType

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

Formats the IDs into the string representation of this MetadataSchemaName with pattern projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

metadataStoreIdString

The MetadataStore ID. Must not be null or empty.

metadataSchemaIdString

The MetadataSchema ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this MetadataSchemaName with pattern projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema} .

FormatProjectLocationMetadataStoreMetadataSchema(String, String, String, String)

public static string FormatProjectLocationMetadataStoreMetadataSchema(string projectId, string locationId, string metadataStoreId, string metadataSchemaId)

Formats the IDs into the string representation of this MetadataSchemaName with pattern projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

metadataStoreIdString

The MetadataStore ID. Must not be null or empty.

metadataSchemaIdString

The MetadataSchema ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this MetadataSchemaName with pattern projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema} .

FromProjectLocationMetadataStoreMetadataSchema(String, String, String, String)

public static MetadataSchemaName FromProjectLocationMetadataStoreMetadataSchema(string projectId, string locationId, string metadataStoreId, string metadataSchemaId)

Creates a MetadataSchemaName with the pattern projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

metadataStoreIdString

The MetadataStore ID. Must not be null or empty.

metadataSchemaIdString

The MetadataSchema ID. Must not be null or empty.

Returns
TypeDescription
MetadataSchemaName

A new instance of MetadataSchemaName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MetadataSchemaName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MetadataSchemaName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
MetadataSchemaName

A new instance of MetadataSchemaName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static MetadataSchemaName Parse(string metadataSchemaName)

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

Parameter
NameDescription
metadataSchemaNameString

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

Returns
TypeDescription
MetadataSchemaName

The parsed MetadataSchemaName if successful.

Remarks

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

  • projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema}

Parse(String, Boolean)

public static MetadataSchemaName Parse(string metadataSchemaName, bool allowUnparsed)

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

Parameters
NameDescription
metadataSchemaNameString

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

allowUnparsedBoolean

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
MetadataSchemaName

The parsed MetadataSchemaName if successful.

Remarks

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

  • projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema}
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 MetadataSchemaName)

public static bool TryParse(string metadataSchemaName, out MetadataSchemaName result)

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

Parameters
NameDescription
metadataSchemaNameString

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

resultMetadataSchemaName

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

Returns
TypeDescription
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}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema}

TryParse(String, Boolean, out MetadataSchemaName)

public static bool TryParse(string metadataSchemaName, bool allowUnparsed, out MetadataSchemaName result)

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

Parameters
NameDescription
metadataSchemaNameString

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

allowUnparsedBoolean

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.

resultMetadataSchemaName

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

Returns
TypeDescription
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}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema}
Or may be in any format if allowUnparsed is true.

Operators

Equality(MetadataSchemaName, MetadataSchemaName)

public static bool operator ==(MetadataSchemaName a, MetadataSchemaName b)
Parameters
NameDescription
aMetadataSchemaName
bMetadataSchemaName
Returns
TypeDescription
Boolean

Inequality(MetadataSchemaName, MetadataSchemaName)

public static bool operator !=(MetadataSchemaName a, MetadataSchemaName b)
Parameters
NameDescription
aMetadataSchemaName
bMetadataSchemaName
Returns
TypeDescription
Boolean