Cloud AI Platform v1 API - Class MetadataSchemaName (3.13.0) 

public sealed class MetadataSchemaName : IResourceName, IEquatable<MetadataSchemaName>

Reference documentation and code samples for the Cloud AI Platform v1 API class 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
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
metadataStoreId string

The MetadataStore ID. Must not be null or empty.
metadataSchemaId string

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

MetadataSchemaId

public string MetadataSchemaId { get; }

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

Property Value
Type Description
string

MetadataStoreId

public string MetadataStoreId { get; }

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

The MetadataSchemaName.ResourceNameType of the contained resource name.

Property Value
Type Description
MetadataSchemaNameResourceNameType

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 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
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
metadataStoreId string

The MetadataStore ID. Must not be null or empty.
metadataSchemaId string

The MetadataSchema ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
metadataStoreId string

The MetadataStore ID. Must not be null or empty.
metadataSchemaId string

The MetadataSchema ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
metadataStoreId string

The MetadataStore ID. Must not be null or empty.
metadataSchemaId string

The MetadataSchema ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
MetadataSchemaName

A new instance of MetadataSchemaName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static MetadataSchemaName Parse(string metadataSchemaName)

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

Parameter
Name Description
metadataSchemaName string

The resource name in string form. Must not be null.
Returns
Type Description
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, bool)

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
Name Description
metadataSchemaName 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
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
Type Description
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
Name Description
metadataSchemaName string

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

When this method returns, the parsed MetadataSchemaName, 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}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema}

TryParse(string, bool, 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
Name Description
metadataSchemaName 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 MetadataSchemaName

When this method returns, the parsed MetadataSchemaName, 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}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(MetadataSchemaName, MetadataSchemaName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MetadataSchemaName

The first resource name to compare, or null.
b MetadataSchemaName

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 !=(MetadataSchemaName, MetadataSchemaName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MetadataSchemaName

The first resource name to compare, or null.
b MetadataSchemaName

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.