Cloud AI Platform v1 API - Class PersistentResourceName (3.1.0)

Version 3.1.0

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class PersistentResourceName : IResourceName, IEquatable<PersistentResourceName>

Reference documentation and code samples for the Cloud AI Platform v1 API class PersistentResourceName.

Resource name for the PersistentResource resource.

Inheritance

object > PersistentResourceName

Implements

IResourceName, IEquatablePersistentResourceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

PersistentResourceName(string, string, string)

public PersistentResourceName(string projectId, string locationId, string persistentResourceId)

Constructs a new instance of a PersistentResourceName class from the component parts of pattern projects/{project}/locations/{location}/persistentResources/{persistent_resource}

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.
persistentResourceId	string The PersistentResource 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

PersistentResourceId

public string PersistentResourceId { get; }

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

The PersistentResourceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
PersistentResourceNameResourceNameType

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

Formats the IDs into the string representation of this PersistentResourceName with pattern projects/{project}/locations/{location}/persistentResources/{persistent_resource}.

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.
persistentResourceId	string The PersistentResource ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this PersistentResourceName with pattern projects/{project}/locations/{location}/persistentResources/{persistent_resource}.

FormatProjectLocationPersistentResource(string, string, string)

public static string FormatProjectLocationPersistentResource(string projectId, string locationId, string persistentResourceId)

Formats the IDs into the string representation of this PersistentResourceName with pattern projects/{project}/locations/{location}/persistentResources/{persistent_resource}.

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.
persistentResourceId	string The PersistentResource ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this PersistentResourceName with pattern projects/{project}/locations/{location}/persistentResources/{persistent_resource}.

FromProjectLocationPersistentResource(string, string, string)

public static PersistentResourceName FromProjectLocationPersistentResource(string projectId, string locationId, string persistentResourceId)

Creates a PersistentResourceName with the pattern projects/{project}/locations/{location}/persistentResources/{persistent_resource}.

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.
persistentResourceId	string The PersistentResource ID. Must not be null or empty.

Returns
Type	Description
PersistentResourceName	A new instance of PersistentResourceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PersistentResourceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PersistentResourceName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
PersistentResourceName	A new instance of PersistentResourceName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static PersistentResourceName Parse(string persistentResourceName)

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

Parameter
Name	Description
persistentResourceName	string The resource name in string form. Must not be null.

Returns
Type	Description
PersistentResourceName	The parsed PersistentResourceName if successful.

Remarks

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

• projects/{project}/locations/{location}/persistentResources/{persistent_resource}

Parse(string, bool)

public static PersistentResourceName Parse(string persistentResourceName, bool allowUnparsed)

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

Parameters
Name	Description
persistentResourceName	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
PersistentResourceName	The parsed PersistentResourceName if successful.

Remarks

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

• projects/{project}/locations/{location}/persistentResources/{persistent_resource}

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

object.ToString()

TryParse(string, out PersistentResourceName)

public static bool TryParse(string persistentResourceName, out PersistentResourceName result)

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

Parameters
Name	Description
persistentResourceName	string The resource name in string form. Must not be null.
result	PersistentResourceName When this method returns, the parsed PersistentResourceName, 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}/persistentResources/{persistent_resource}

TryParse(string, bool, out PersistentResourceName)

public static bool TryParse(string persistentResourceName, bool allowUnparsed, out PersistentResourceName result)

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

Parameters
Name	Description
persistentResourceName	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	PersistentResourceName When this method returns, the parsed PersistentResourceName, 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}/persistentResources/{persistent_resource}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PersistentResourceName, PersistentResourceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	PersistentResourceName The first resource name to compare, or null.
b	PersistentResourceName 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 !=(PersistentResourceName, PersistentResourceName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	PersistentResourceName The first resource name to compare, or null.
b	PersistentResourceName 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.