Cloud Storage v2 API - Class AnywhereCacheName (1.3.0) 

public sealed class AnywhereCacheName : IResourceName, IEquatable<AnywhereCacheName>

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

Resource name for the AnywhereCache resource.

Inheritance

object > AnywhereCacheName

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

AnywhereCacheName(string, string, string)

public AnywhereCacheName(string projectId, string bucketId, string anywhereCacheId)

Constructs a new instance of a AnywhereCacheName class from the component parts of pattern projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_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.
anywhereCacheId string

The AnywhereCache ID. Must not be null or empty.

Properties

AnywhereCacheId

public string AnywhereCacheId { get; }

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

Property Value
Type Description
string

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

Type

public AnywhereCacheName.ResourceNameType Type { get; }

The AnywhereCacheName.ResourceNameType of the contained resource name.

Property Value
Type Description
AnywhereCacheNameResourceNameType

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

Formats the IDs into the string representation of this AnywhereCacheName with pattern projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_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.
anywhereCacheId string

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

The string representation of this AnywhereCacheName with pattern projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}.

FormatProjectBucketAnywhereCache(string, string, string)

public static string FormatProjectBucketAnywhereCache(string projectId, string bucketId, string anywhereCacheId)

Formats the IDs into the string representation of this AnywhereCacheName with pattern projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_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.
anywhereCacheId string

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

The string representation of this AnywhereCacheName with pattern projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}.

FromProjectBucketAnywhereCache(string, string, string)

public static AnywhereCacheName FromProjectBucketAnywhereCache(string projectId, string bucketId, string anywhereCacheId)

Creates a AnywhereCacheName with the pattern projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_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.
anywhereCacheId string

The AnywhereCache ID. Must not be null or empty.
Returns
Type Description
AnywhereCacheName

A new instance of AnywhereCacheName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AnywhereCacheName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AnywhereCacheName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
anywhereCacheName string

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

The parsed AnywhereCacheName if successful.
Remarks

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

  • projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

Parse(string, bool)

public static AnywhereCacheName Parse(string anywhereCacheName, bool allowUnparsed)

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

Parameters
Name Description
anywhereCacheName 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
AnywhereCacheName

The parsed AnywhereCacheName if successful.
Remarks

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

  • projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_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

TryParse(string, out AnywhereCacheName)

public static bool TryParse(string anywhereCacheName, out AnywhereCacheName result)

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

Parameters
Name Description
anywhereCacheName string

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

When this method returns, the parsed AnywhereCacheName, 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}/anywhereCaches/{anywhere_cache}

TryParse(string, bool, out AnywhereCacheName)

public static bool TryParse(string anywhereCacheName, bool allowUnparsed, out AnywhereCacheName result)

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

Parameters
Name Description
anywhereCacheName 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 AnywhereCacheName

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

Operators

operator ==(AnywhereCacheName, AnywhereCacheName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AnywhereCacheName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AnywhereCacheName

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

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.