Vertex AI v1 API - Class PublisherModelName (3.50.0) 

public sealed class PublisherModelName : IResourceName, IEquatable<PublisherModelName>

Reference documentation and code samples for the Vertex AI v1 API class PublisherModelName.

Resource name for the PublisherModel resource.

Inheritance

object > PublisherModelName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

PublisherModelName(string, string)

public PublisherModelName(string publisherId, string modelId)

Constructs a new instance of a PublisherModelName class from the component parts of pattern publishers/{publisher}/models/{model}

Parameters
Name Description
publisherId string

The Publisher ID. Must not be null or empty.
modelId string

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

ModelId

public string ModelId { get; }

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

Property Value
Type Description
string

PublisherId

public string PublisherId { get; }

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

Property Value
Type Description
string

Type

public PublisherModelName.ResourceNameType Type { get; }

The PublisherModelName.ResourceNameType of the contained resource name.

Property Value
Type Description
PublisherModelNameResourceNameType

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)

public static string Format(string publisherId, string modelId)

Formats the IDs into the string representation of this PublisherModelName with pattern publishers/{publisher}/models/{model}.

Parameters
Name Description
publisherId string

The Publisher ID. Must not be null or empty.
modelId string

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

The string representation of this PublisherModelName with pattern publishers/{publisher}/models/{model}.

FormatPublisherModel(string, string)

public static string FormatPublisherModel(string publisherId, string modelId)

Formats the IDs into the string representation of this PublisherModelName with pattern publishers/{publisher}/models/{model}.

Parameters
Name Description
publisherId string

The Publisher ID. Must not be null or empty.
modelId string

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

The string representation of this PublisherModelName with pattern publishers/{publisher}/models/{model}.

FromPublisherModel(string, string)

public static PublisherModelName FromPublisherModel(string publisherId, string modelId)

Creates a PublisherModelName with the pattern publishers/{publisher}/models/{model}.

Parameters
Name Description
publisherId string

The Publisher ID. Must not be null or empty.
modelId string

The Model ID. Must not be null or empty.
Returns
Type Description
PublisherModelName

A new instance of PublisherModelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PublisherModelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PublisherModelName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
publisherModelName string

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

The parsed PublisherModelName if successful.
Remarks

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

  • publishers/{publisher}/models/{model}

Parse(string, bool)

public static PublisherModelName Parse(string publisherModelName, bool allowUnparsed)

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

Parameters
Name Description
publisherModelName 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
PublisherModelName

The parsed PublisherModelName if successful.
Remarks

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

  • publishers/{publisher}/models/{model}
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 PublisherModelName)

public static bool TryParse(string publisherModelName, out PublisherModelName result)

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

Parameters
Name Description
publisherModelName string

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

When this method returns, the parsed PublisherModelName, 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:

  • publishers/{publisher}/models/{model}

TryParse(string, bool, out PublisherModelName)

public static bool TryParse(string publisherModelName, bool allowUnparsed, out PublisherModelName result)

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

Parameters
Name Description
publisherModelName 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 PublisherModelName

When this method returns, the parsed PublisherModelName, 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:

  • publishers/{publisher}/models/{model}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PublisherModelName, PublisherModelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PublisherModelName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PublisherModelName

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

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.