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

public sealed class ManagedFolderName : IResourceName, IEquatable<ManagedFolderName>

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

Resource name for the ManagedFolder resource.

Inheritance

object > ManagedFolderName

Implements

IResourceName, IEquatable ManagedFolderName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

ManagedFolderName(string, string, string)

public ManagedFolderName(string projectId, string bucketId, string managedFolderId)

Constructs a new instance of a ManagedFolderName class from the component parts of pattern projects/{project}/buckets/{bucket}/managedFolders/{managed_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.
`managedFolderId`	`string` The `ManagedFolder` 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`

ManagedFolderId

public string ManagedFolderId { get; }

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

Property Value
Type	Description
`string`

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

The ManagedFolderName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ManagedFolderNameResourceNameType`

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

Formats the IDs into the string representation of this ManagedFolderName with pattern projects/{project}/buckets/{bucket}/managedFolders/{managed_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.
`managedFolderId`	`string` The `ManagedFolder` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ManagedFolderName with pattern `projects/{project}/buckets/{bucket}/managedFolders/{managed_folder=**}`.

FormatProjectBucketManagedFolder(string, string, string)

public static string FormatProjectBucketManagedFolder(string projectId, string bucketId, string managedFolderId)

Formats the IDs into the string representation of this ManagedFolderName with pattern projects/{project}/buckets/{bucket}/managedFolders/{managed_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.
`managedFolderId`	`string` The `ManagedFolder` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ManagedFolderName with pattern `projects/{project}/buckets/{bucket}/managedFolders/{managed_folder=**}`.

FromProjectBucketManagedFolder(string, string, string)

public static ManagedFolderName FromProjectBucketManagedFolder(string projectId, string bucketId, string managedFolderId)

Creates a ManagedFolderName with the pattern projects/{project}/buckets/{bucket}/managedFolders/{managed_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.
`managedFolderId`	`string` The `ManagedFolder` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ManagedFolderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ManagedFolderName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/buckets/{bucket}/managedFolders/{managed_folder=**}

Parse(string, bool)

public static ManagedFolderName Parse(string managedFolderName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/buckets/{bucket}/managedFolders/{managed_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 ManagedFolderName)

public static bool TryParse(string managedFolderName, out ManagedFolderName result)

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

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

TryParse(string, bool, out ManagedFolderName)

public static bool TryParse(string managedFolderName, bool allowUnparsed, out ManagedFolderName result)

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

Parameters
Name	Description
`managedFolderName`	`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`	`ManagedFolderName` When this method returns, the parsed ManagedFolderName, 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}/managedFolders/{managed_folder=**}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ManagedFolderName, ManagedFolderName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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