Cloud Storage v2 API - Class BucketName (1.5.0)

public sealed class BucketName : IResourceName, IEquatable<BucketName>

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

Resource name for the Bucket resource.

Inheritance

object > BucketName

Implements

IResourceName, IEquatable BucketName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

BucketName(string, string)

public BucketName(string projectId, string bucketId)

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

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 BucketName.ResourceNameType Type { get; }

The BucketName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`BucketNameResourceNameType`

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 BucketName with pattern projects/{project}/buckets/{bucket}.

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 BucketName with pattern `projects/{project}/buckets/{bucket}`.

FormatProjectBucket(string, string)

public static string FormatProjectBucket(string projectId, string bucketId)

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

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 BucketName with pattern `projects/{project}/buckets/{bucket}`.

FromProjectBucket(string, string)

public static BucketName FromProjectBucket(string projectId, string bucketId)

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

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
`BucketName`	A new instance of BucketName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BucketName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BucketName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/buckets/{bucket}

Parse(string, bool)

public static BucketName Parse(string bucketName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/buckets/{bucket}

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

public static bool TryParse(string bucketName, out BucketName result)

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

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

TryParse(string, bool, out BucketName)

public static bool TryParse(string bucketName, bool allowUnparsed, out BucketName result)

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

Parameters
Name	Description
`bucketName`	`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`	`BucketName` When this method returns, the parsed BucketName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BucketName, BucketName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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