Backup and DR Service v1 API - Class BackupVaultName (1.2.0)

public sealed class BackupVaultName : IResourceName, IEquatable<BackupVaultName>

Reference documentation and code samples for the Backup and DR Service v1 API class BackupVaultName.

Resource name for the BackupVault resource.

Inheritance

object > BackupVaultName

Implements

IResourceName, IEquatable BackupVaultName

Inherited Members

object.GetType()

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

BackupVaultName(string, string, string)

public BackupVaultName(string projectId, string locationId, string backupvaultId)

Constructs a new instance of a BackupVaultName class from the component parts of pattern projects/{project}/locations/{location}/backupVaults/{backupvault}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`backupvaultId`	`string` The `Backupvault` ID. Must not be `null` or empty.

Properties

BackupvaultId

public string BackupvaultId { get; }

The Backupvault 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`

LocationId

public string LocationId { get; }

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

The BackupVaultName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`BackupVaultNameResourceNameType`

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 locationId, string backupvaultId)

Formats the IDs into the string representation of this BackupVaultName with pattern projects/{project}/locations/{location}/backupVaults/{backupvault}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`backupvaultId`	`string` The `Backupvault` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this BackupVaultName with pattern `projects/{project}/locations/{location}/backupVaults/{backupvault}`.

FormatProjectLocationBackupvault(string, string, string)

public static string FormatProjectLocationBackupvault(string projectId, string locationId, string backupvaultId)

Formats the IDs into the string representation of this BackupVaultName with pattern projects/{project}/locations/{location}/backupVaults/{backupvault}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`backupvaultId`	`string` The `Backupvault` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this BackupVaultName with pattern `projects/{project}/locations/{location}/backupVaults/{backupvault}`.

FromProjectLocationBackupvault(string, string, string)

public static BackupVaultName FromProjectLocationBackupvault(string projectId, string locationId, string backupvaultId)

Creates a BackupVaultName with the pattern projects/{project}/locations/{location}/backupVaults/{backupvault}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`backupvaultId`	`string` The `Backupvault` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static BackupVaultName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BackupVaultName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/backupVaults/{backupvault}

Parse(string, bool)

public static BackupVaultName Parse(string backupVaultName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/backupVaults/{backupvault}

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

public static bool TryParse(string backupVaultName, out BackupVaultName result)

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

Parameters
Name	Description
`backupVaultName`	`string` The resource name in string form. Must not be `null`.
`result`	`BackupVaultName` When this method returns, the parsed BackupVaultName, 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}/locations/{location}/backupVaults/{backupvault}

TryParse(string, bool, out BackupVaultName)

public static bool TryParse(string backupVaultName, bool allowUnparsed, out BackupVaultName result)

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

Parameters
Name	Description
`backupVaultName`	`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`	`BackupVaultName` When this method returns, the parsed BackupVaultName, 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}/locations/{location}/backupVaults/{backupvault}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BackupVaultName, BackupVaultName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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