Vertex AI v1beta1 API - Class ExampleStoreName (1.0.0-beta25) 

public sealed class ExampleStoreName : IResourceName, IEquatable<ExampleStoreName>

Reference documentation and code samples for the Vertex AI v1beta1 API class ExampleStoreName.

Resource name for the ExampleStore resource.

Inheritance

object > ExampleStoreName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

ExampleStoreName(string, string, string)

public ExampleStoreName(string projectId, string locationId, string exampleStoreId)

Constructs a new instance of a ExampleStoreName class from the component parts of pattern projects/{project}/locations/{location}/exampleStores/{example_store}

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.
exampleStoreId string

The ExampleStore ID. Must not be null or empty.

Properties

ExampleStoreId

public string ExampleStoreId { get; }

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

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. 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 ExampleStoreName.ResourceNameType Type { get; }

The ExampleStoreName.ResourceNameType of the contained resource name.

Property Value
Type Description
ExampleStoreNameResourceNameType

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

Formats the IDs into the string representation of this ExampleStoreName with pattern projects/{project}/locations/{location}/exampleStores/{example_store}.

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.
exampleStoreId string

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

The string representation of this ExampleStoreName with pattern projects/{project}/locations/{location}/exampleStores/{example_store}.

FormatProjectLocationExampleStore(string, string, string)

public static string FormatProjectLocationExampleStore(string projectId, string locationId, string exampleStoreId)

Formats the IDs into the string representation of this ExampleStoreName with pattern projects/{project}/locations/{location}/exampleStores/{example_store}.

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.
exampleStoreId string

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

The string representation of this ExampleStoreName with pattern projects/{project}/locations/{location}/exampleStores/{example_store}.

FromProjectLocationExampleStore(string, string, string)

public static ExampleStoreName FromProjectLocationExampleStore(string projectId, string locationId, string exampleStoreId)

Creates a ExampleStoreName with the pattern projects/{project}/locations/{location}/exampleStores/{example_store}.

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.
exampleStoreId string

The ExampleStore ID. Must not be null or empty.
Returns
Type Description
ExampleStoreName

A new instance of ExampleStoreName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ExampleStoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ExampleStoreName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
exampleStoreName string

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

The parsed ExampleStoreName if successful.
Remarks

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

  • projects/{project}/locations/{location}/exampleStores/{example_store}

Parse(string, bool)

public static ExampleStoreName Parse(string exampleStoreName, bool allowUnparsed)

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

Parameters
Name Description
exampleStoreName 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
ExampleStoreName

The parsed ExampleStoreName if successful.
Remarks

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

  • projects/{project}/locations/{location}/exampleStores/{example_store}
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 ExampleStoreName)

public static bool TryParse(string exampleStoreName, out ExampleStoreName result)

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

Parameters
Name Description
exampleStoreName string

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

When this method returns, the parsed ExampleStoreName, 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}/exampleStores/{example_store}

TryParse(string, bool, out ExampleStoreName)

public static bool TryParse(string exampleStoreName, bool allowUnparsed, out ExampleStoreName result)

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

Parameters
Name Description
exampleStoreName 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 ExampleStoreName

When this method returns, the parsed ExampleStoreName, 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}/exampleStores/{example_store}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ExampleStoreName, ExampleStoreName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ExampleStoreName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ExampleStoreName

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

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.