Cloud AI Platform v1beta1 API - Class CachedContentName (1.0.0-beta09) 

public sealed class CachedContentName : IResourceName, IEquatable<CachedContentName>

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

Resource name for the CachedContent resource.

Inheritance

object > CachedContentName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

CachedContentName(string, string, string)

public CachedContentName(string projectId, string locationId, string cachedContentId)

Constructs a new instance of a CachedContentName class from the component parts of pattern projects/{project}/locations/{location}/cachedContents/{cached_content}

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

The CachedContent ID. Must not be null or empty.

Properties

CachedContentId

public string CachedContentId { get; }

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

The CachedContentName.ResourceNameType of the contained resource name.

Property Value
Type Description
CachedContentNameResourceNameType

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

Formats the IDs into the string representation of this CachedContentName with pattern projects/{project}/locations/{location}/cachedContents/{cached_content}.

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

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

The string representation of this CachedContentName with pattern projects/{project}/locations/{location}/cachedContents/{cached_content}.

FormatProjectLocationCachedContent(string, string, string)

public static string FormatProjectLocationCachedContent(string projectId, string locationId, string cachedContentId)

Formats the IDs into the string representation of this CachedContentName with pattern projects/{project}/locations/{location}/cachedContents/{cached_content}.

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

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

The string representation of this CachedContentName with pattern projects/{project}/locations/{location}/cachedContents/{cached_content}.

FromProjectLocationCachedContent(string, string, string)

public static CachedContentName FromProjectLocationCachedContent(string projectId, string locationId, string cachedContentId)

Creates a CachedContentName with the pattern projects/{project}/locations/{location}/cachedContents/{cached_content}.

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

The CachedContent ID. Must not be null or empty.
Returns
Type Description
CachedContentName

A new instance of CachedContentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CachedContentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CachedContentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
cachedContentName string

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

The parsed CachedContentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/cachedContents/{cached_content}

Parse(string, bool)

public static CachedContentName Parse(string cachedContentName, bool allowUnparsed)

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

Parameters
Name Description
cachedContentName 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
CachedContentName

The parsed CachedContentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/cachedContents/{cached_content}
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 CachedContentName)

public static bool TryParse(string cachedContentName, out CachedContentName result)

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

Parameters
Name Description
cachedContentName string

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

When this method returns, the parsed CachedContentName, 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}/cachedContents/{cached_content}

TryParse(string, bool, out CachedContentName)

public static bool TryParse(string cachedContentName, bool allowUnparsed, out CachedContentName result)

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

Parameters
Name Description
cachedContentName 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 CachedContentName

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

Operators

operator ==(CachedContentName, CachedContentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CachedContentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CachedContentName

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

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.