Cloud Storage v2 API - Class FolderName (1.0.0-beta04)

public sealed class FolderName : IResourceName, IEquatable<FolderName>

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

Resource name for the Folder resource.

Inheritance

object > FolderName

Implements

IResourceName, IEquatable FolderName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

FolderName(string, string, string)

public FolderName(string projectId, string bucketId, string folderId)

Constructs a new instance of a FolderName class from the component parts of pattern projects/{project}/buckets/{bucket}/folders/{folder=**}

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.
`folderId`	`string` The `Folder` 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`

FolderId

public string FolderId { get; }

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

The FolderName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`FolderNameResourceNameType`

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

Formats the IDs into the string representation of this FolderName with pattern projects/{project}/buckets/{bucket}/folders/{folder=**}.

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.
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FolderName with pattern `projects/{project}/buckets/{bucket}/folders/{folder=**}`.

FormatProjectBucketFolder(string, string, string)

public static string FormatProjectBucketFolder(string projectId, string bucketId, string folderId)

Formats the IDs into the string representation of this FolderName with pattern projects/{project}/buckets/{bucket}/folders/{folder=**}.

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.
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FolderName with pattern `projects/{project}/buckets/{bucket}/folders/{folder=**}`.

FromProjectBucketFolder(string, string, string)

public static FolderName FromProjectBucketFolder(string projectId, string bucketId, string folderId)

Creates a FolderName with the pattern projects/{project}/buckets/{bucket}/folders/{folder=**}.

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.
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static FolderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FolderName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/buckets/{bucket}/folders/{folder=**}

Parse(string, bool)

public static FolderName Parse(string folderName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/buckets/{bucket}/folders/{folder=**}

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

public static bool TryParse(string folderName, out FolderName result)

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

Parameters
Name	Description
`folderName`	`string` The resource name in string form. Must not be `null`.
`result`	`FolderName` When this method returns, the parsed FolderName, 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}/folders/{folder=**}

TryParse(string, bool, out FolderName)

public static bool TryParse(string folderName, bool allowUnparsed, out FolderName result)

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

Parameters
Name	Description
`folderName`	`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`	`FolderName` When this method returns, the parsed FolderName, 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}/folders/{folder=**}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FolderName, FolderName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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