Cloud Storage v2 API - Class RapidCacheName (1.9.0)

public sealed class RapidCacheName : IResourceName, IEquatable<RapidCacheName>

Reference documentation and code samples for the Cloud Storage v2 API class RapidCacheName.

Resource name for the RapidCache resource.

Inheritance

object > RapidCacheName

Implements

IResourceName, IEquatable RapidCacheName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

RapidCacheName(string, string, string)

public RapidCacheName(string projectId, string bucketId, string rapidCacheId)

Constructs a new instance of a RapidCacheName class from the component parts of pattern projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`rapidCacheId`	`string` The `RapidCache` ID. Must not be `null` or empty.

Properties

BucketId

public string BucketId { get; }

The Bucket 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`

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`

RapidCacheId

public string RapidCacheId { get; }

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

Property Value
Type	Description
`string`

Type

public RapidCacheName.ResourceNameType Type { get; }

The RapidCacheName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`RapidCacheNameResourceNameType`

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 bucketId, string rapidCacheId)

Formats the IDs into the string representation of this RapidCacheName with pattern projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`rapidCacheId`	`string` The `RapidCache` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this RapidCacheName with pattern `projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}`.

FormatProjectBucketRapidCache(string, string, string)

public static string FormatProjectBucketRapidCache(string projectId, string bucketId, string rapidCacheId)

Formats the IDs into the string representation of this RapidCacheName with pattern projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`rapidCacheId`	`string` The `RapidCache` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this RapidCacheName with pattern `projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}`.

FromProjectBucketRapidCache(string, string, string)

public static RapidCacheName FromProjectBucketRapidCache(string projectId, string bucketId, string rapidCacheId)

Creates a RapidCacheName with the pattern projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`rapidCacheId`	`string` The `RapidCache` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static RapidCacheName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RapidCacheName containing an unparsed resource name.

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

Returns
Type	Description
`RapidCacheName`	A new instance of RapidCacheName 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 RapidCacheName Parse(string rapidCacheName)

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

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

Returns
Type	Description
`RapidCacheName`	The parsed RapidCacheName if successful.

Remarks

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

projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}

Parse(string, bool)

public static RapidCacheName Parse(string rapidCacheName, bool allowUnparsed)

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

Parameters
Name	Description
`rapidCacheName`	`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
`RapidCacheName`	The parsed RapidCacheName if successful.

Remarks

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

projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}

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

public static bool TryParse(string rapidCacheName, out RapidCacheName result)

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

Parameters
Name	Description
`rapidCacheName`	`string` The resource name in string form. Must not be `null`.
`result`	`RapidCacheName` When this method returns, the parsed RapidCacheName, 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}/buckets/{bucket}/rapidCaches/{rapid_cache}

TryParse(string, bool, out RapidCacheName)

public static bool TryParse(string rapidCacheName, bool allowUnparsed, out RapidCacheName result)

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

Parameters
Name	Description
`rapidCacheName`	`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`	`RapidCacheName` When this method returns, the parsed RapidCacheName, 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}/buckets/{bucket}/rapidCaches/{rapid_cache}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RapidCacheName, RapidCacheName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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

Cloud Storage v2 API - Class RapidCacheName (1.9.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Namespace

Assembly

Constructors

RapidCacheName(string, string, string)

Properties

BucketId

IsKnownPattern

ProjectId

RapidCacheId

Type

UnparsedResource

Methods

Format(string, string, string)

FormatProjectBucketRapidCache(string, string, string)

FromProjectBucketRapidCache(string, string, string)

FromUnparsed(UnparsedResourceName)

GetHashCode()

Parse(string)

Parse(string, bool)

ToString()

TryParse(string, out RapidCacheName)

TryParse(string, bool, out RapidCacheName)

Operators

operator ==(RapidCacheName, RapidCacheName)

operator !=(RapidCacheName, RapidCacheName)

Cloud Storage v2 API - Class RapidCacheName (1.9.0)