Cloud Storage v2 API - Class StorageLayoutName (1.0.0-beta02)

Version 1.0.0-beta02

• 1.1.0 (latest)
• 1.0.1

public sealed class StorageLayoutName : IResourceName, IEquatable<StorageLayoutName>

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

Resource name for the StorageLayout resource.

Inheritance

object > StorageLayoutName

Implements

IResourceName, IEquatableStorageLayoutName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

StorageLayoutName(string, string)

public StorageLayoutName(string projectId, string bucketId)

Constructs a new instance of a StorageLayoutName class from the component parts of pattern projects/{project}/buckets/{bucket}/storageLayout

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.

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

Type

public StorageLayoutName.ResourceNameType Type { get; }

The StorageLayoutName.ResourceNameType of the contained resource name.

Property Value
Type	Description
StorageLayoutNameResourceNameType

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)

public static string Format(string projectId, string bucketId)

Formats the IDs into the string representation of this StorageLayoutName with pattern projects/{project}/buckets/{bucket}/storageLayout.

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.

Returns
Type	Description
string	The string representation of this StorageLayoutName with pattern projects/{project}/buckets/{bucket}/storageLayout.

FormatProjectBucket(string, string)

public static string FormatProjectBucket(string projectId, string bucketId)

Formats the IDs into the string representation of this StorageLayoutName with pattern projects/{project}/buckets/{bucket}/storageLayout.

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.

Returns
Type	Description
string	The string representation of this StorageLayoutName with pattern projects/{project}/buckets/{bucket}/storageLayout.

FromProjectBucket(string, string)

public static StorageLayoutName FromProjectBucket(string projectId, string bucketId)

Creates a StorageLayoutName with the pattern projects/{project}/buckets/{bucket}/storageLayout.

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.

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

FromUnparsed(UnparsedResourceName)

public static StorageLayoutName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a StorageLayoutName containing an unparsed resource name.

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

Returns
Type	Description
StorageLayoutName	A new instance of StorageLayoutName 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 StorageLayoutName Parse(string storageLayoutName)

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

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

Returns
Type	Description
StorageLayoutName	The parsed StorageLayoutName if successful.

Remarks

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

• projects/{project}/buckets/{bucket}/storageLayout

Parse(string, bool)

public static StorageLayoutName Parse(string storageLayoutName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/buckets/{bucket}/storageLayout

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

public static bool TryParse(string storageLayoutName, out StorageLayoutName result)

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

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

TryParse(string, bool, out StorageLayoutName)

public static bool TryParse(string storageLayoutName, bool allowUnparsed, out StorageLayoutName result)

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

Parameters
Name	Description
storageLayoutName	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	StorageLayoutName When this method returns, the parsed StorageLayoutName, 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}/storageLayout

Or may be in any format if allowUnparsed is true.

Operators

operator ==(StorageLayoutName, StorageLayoutName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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