Discovery Engine v1 API - Class SchemaName (1.10.0) 

public sealed class SchemaName : IResourceName, IEquatable<SchemaName>

Reference documentation and code samples for the Discovery Engine v1 API class SchemaName.

Resource name for the Schema resource.

Inheritance

object > SchemaName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

SchemaName(string, string, string, string)

public SchemaName(string projectId, string locationId, string dataStoreId, string schemaId)

Constructs a new instance of a SchemaName class from the component parts of pattern projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{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.
dataStoreId string

The DataStore ID. Must not be null or empty.
schemaId string

The Schema ID. Must not be null or empty.

Properties

CollectionId

public string CollectionId { get; }

The Collection ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

DataStoreId

public string DataStoreId { get; }

The DataStore ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

SchemaId

public string SchemaId { get; }

The Schema ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public SchemaName.ResourceNameType Type { get; }

The SchemaName.ResourceNameType of the contained resource name.

Property Value
Type Description
SchemaNameResourceNameType

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

Formats the IDs into the string representation of this SchemaName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{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.
dataStoreId string

The DataStore ID. Must not be null or empty.
schemaId string

The Schema ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SchemaName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}.

FormatProjectLocationCollectionDataStoreSchema(string, string, string, string, string)

public static string FormatProjectLocationCollectionDataStoreSchema(string projectId, string locationId, string collectionId, string dataStoreId, string schemaId)

Formats the IDs into the string representation of this SchemaName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{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.
collectionId string

The Collection ID. Must not be null or empty.
dataStoreId string

The DataStore ID. Must not be null or empty.
schemaId string

The Schema ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SchemaName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema} .

FormatProjectLocationDataStoreSchema(string, string, string, string)

public static string FormatProjectLocationDataStoreSchema(string projectId, string locationId, string dataStoreId, string schemaId)

Formats the IDs into the string representation of this SchemaName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{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.
dataStoreId string

The DataStore ID. Must not be null or empty.
schemaId string

The Schema ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SchemaName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}.

FromProjectLocationCollectionDataStoreSchema(string, string, string, string, string)

public static SchemaName FromProjectLocationCollectionDataStoreSchema(string projectId, string locationId, string collectionId, string dataStoreId, string schemaId)

Creates a SchemaName with the pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{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.
collectionId string

The Collection ID. Must not be null or empty.
dataStoreId string

The DataStore ID. Must not be null or empty.
schemaId string

The Schema ID. Must not be null or empty.
Returns
Type Description
SchemaName

A new instance of SchemaName constructed from the provided ids.

FromProjectLocationDataStoreSchema(string, string, string, string)

public static SchemaName FromProjectLocationDataStoreSchema(string projectId, string locationId, string dataStoreId, string schemaId)

Creates a SchemaName with the pattern projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{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.
dataStoreId string

The DataStore ID. Must not be null or empty.
schemaId string

The Schema ID. Must not be null or empty.
Returns
Type Description
SchemaName

A new instance of SchemaName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SchemaName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SchemaName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
schemaName string

The resource name in string form. Must not be null.
Returns
Type Description
SchemaName

The parsed SchemaName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}

Parse(string, bool)

public static SchemaName Parse(string schemaName, bool allowUnparsed)

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

Parameters
Name Description
schemaName 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
SchemaName

The parsed SchemaName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{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 SchemaName)

public static bool TryParse(string schemaName, out SchemaName result)

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

Parameters
Name Description
schemaName string

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

When this method returns, the parsed SchemaName, 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}/dataStores/{data_store}/schemas/{schema}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}

TryParse(string, bool, out SchemaName)

public static bool TryParse(string schemaName, bool allowUnparsed, out SchemaName result)

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

Parameters
Name Description
schemaName 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 SchemaName

When this method returns, the parsed SchemaName, 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}/dataStores/{data_store}/schemas/{schema}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SchemaName, SchemaName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SchemaName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SchemaName

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

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.