Cloud AI Platform v1beta1 API - Class EndpointName (1.0.0-beta02) 

public sealed class EndpointName : IResourceName, IEquatable<EndpointName>

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class EndpointName.

Resource name for the Endpoint resource.

Inheritance

object > EndpointName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

EndpointName(string, string, string)

public EndpointName(string projectId, string locationId, string endpointId)

Constructs a new instance of a EndpointName class from the component parts of pattern projects/{project}/locations/{location}/endpoints/{endpoint}

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

The Endpoint ID. Must not be null or empty.

Properties

EndpointId

public string EndpointId { get; }

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

ModelId

public string ModelId { get; }

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

PublisherId

public string PublisherId { get; }

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

Property Value
Type Description
string

Type

public EndpointName.ResourceNameType Type { get; }

The EndpointName.ResourceNameType of the contained resource name.

Property Value
Type Description
EndpointNameResourceNameType

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

Formats the IDs into the string representation of this EndpointName with pattern projects/{project}/locations/{location}/endpoints/{endpoint}.

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

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

The string representation of this EndpointName with pattern projects/{project}/locations/{location}/endpoints/{endpoint}.

FormatProjectLocationEndpoint(string, string, string)

public static string FormatProjectLocationEndpoint(string projectId, string locationId, string endpointId)

Formats the IDs into the string representation of this EndpointName with pattern projects/{project}/locations/{location}/endpoints/{endpoint}.

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

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

The string representation of this EndpointName with pattern projects/{project}/locations/{location}/endpoints/{endpoint}.

FormatProjectLocationPublisherModel(string, string, string, string)

public static string FormatProjectLocationPublisherModel(string projectId, string locationId, string publisherId, string modelId)

Formats the IDs into the string representation of this EndpointName with pattern projects/{project}/locations/{location}/publishers/{publisher}/models/{model}.

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.
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 EndpointName with pattern projects/{project}/locations/{location}/publishers/{publisher}/models/{model}.

FromProjectLocationEndpoint(string, string, string)

public static EndpointName FromProjectLocationEndpoint(string projectId, string locationId, string endpointId)

Creates a EndpointName with the pattern projects/{project}/locations/{location}/endpoints/{endpoint}.

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

The Endpoint ID. Must not be null or empty.
Returns
Type Description
EndpointName

A new instance of EndpointName constructed from the provided ids.

FromProjectLocationPublisherModel(string, string, string, string)

public static EndpointName FromProjectLocationPublisherModel(string projectId, string locationId, string publisherId, string modelId)

Creates a EndpointName with the pattern projects/{project}/locations/{location}/publishers/{publisher}/models/{model}.

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

A new instance of EndpointName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EndpointName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EndpointName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
endpointName string

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

The parsed EndpointName if successful.
Remarks

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

  • projects/{project}/locations/{location}/endpoints/{endpoint}
  • projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

Parse(string, bool)

public static EndpointName Parse(string endpointName, bool allowUnparsed)

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

Parameters
Name Description
endpointName 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
EndpointName

The parsed EndpointName if successful.
Remarks

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

  • projects/{project}/locations/{location}/endpoints/{endpoint}
  • projects/{project}/locations/{location}/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 EndpointName)

public static bool TryParse(string endpointName, out EndpointName result)

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

Parameters
Name Description
endpointName string

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

When this method returns, the parsed EndpointName, 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}/endpoints/{endpoint}
  • projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

TryParse(string, bool, out EndpointName)

public static bool TryParse(string endpointName, bool allowUnparsed, out EndpointName result)

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

Parameters
Name Description
endpointName 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 EndpointName

When this method returns, the parsed EndpointName, 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}/endpoints/{endpoint}
  • projects/{project}/locations/{location}/publishers/{publisher}/models/{model}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EndpointName, EndpointName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EndpointName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EndpointName

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

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.