Backup for GKE v1 API - Class VolumeBackupName (2.2.0)

public sealed class VolumeBackupName : IResourceName, IEquatable<VolumeBackupName>

Reference documentation and code samples for the Backup for GKE v1 API class VolumeBackupName.

Resource name for the VolumeBackup resource.

Inheritance

object > VolumeBackupName

Implements

IResourceName, IEquatable VolumeBackupName

Inherited Members

object.GetType()

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

VolumeBackupName(string, string, string, string, string)

public VolumeBackupName(string projectId, string locationId, string backupPlanId, string backupId, string volumeBackupId)

Constructs a new instance of a VolumeBackupName class from the component parts of pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}

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.
`backupPlanId`	`string` The `BackupPlan` ID. Must not be `null` or empty.
`backupId`	`string` The `Backup` ID. Must not be `null` or empty.
`volumeBackupId`	`string` The `VolumeBackup` ID. Must not be `null` or empty.

Properties

BackupId

public string BackupId { get; }

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

Property Value
Type	Description
`string`

BackupPlanId

public string BackupPlanId { get; }

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

The VolumeBackupName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`VolumeBackupNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
`UnparsedResourceName`

VolumeBackupId

public string VolumeBackupId { get; }

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

Property Value
Type	Description
`string`

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string locationId, string backupPlanId, string backupId, string volumeBackupId)

Formats the IDs into the string representation of this VolumeBackupName with pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup} .

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.
`backupPlanId`	`string` The `BackupPlan` ID. Must not be `null` or empty.
`backupId`	`string` The `Backup` ID. Must not be `null` or empty.
`volumeBackupId`	`string` The `VolumeBackup` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this VolumeBackupName with pattern `projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}` .

FormatProjectLocationBackupPlanBackupVolumeBackup(string, string, string, string, string)

public static string FormatProjectLocationBackupPlanBackupVolumeBackup(string projectId, string locationId, string backupPlanId, string backupId, string volumeBackupId)

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.
`backupPlanId`	`string` The `BackupPlan` ID. Must not be `null` or empty.
`backupId`	`string` The `Backup` ID. Must not be `null` or empty.
`volumeBackupId`	`string` The `VolumeBackup` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this VolumeBackupName with pattern `projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}` .

FromProjectLocationBackupPlanBackupVolumeBackup(string, string, string, string, string)

public static VolumeBackupName FromProjectLocationBackupPlanBackupVolumeBackup(string projectId, string locationId, string backupPlanId, string backupId, string volumeBackupId)

Creates a VolumeBackupName with the pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup} .

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.
`backupPlanId`	`string` The `BackupPlan` ID. Must not be `null` or empty.
`backupId`	`string` The `Backup` ID. Must not be `null` or empty.
`volumeBackupId`	`string` The `VolumeBackup` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static VolumeBackupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VolumeBackupName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}

Parse(string, bool)

public static VolumeBackupName Parse(string volumeBackupName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}

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

public static bool TryParse(string volumeBackupName, out VolumeBackupName result)

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

Parameters
Name	Description
`volumeBackupName`	`string` The resource name in string form. Must not be `null`.
`result`	`VolumeBackupName` When this method returns, the parsed VolumeBackupName, 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}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}

TryParse(string, bool, out VolumeBackupName)

public static bool TryParse(string volumeBackupName, bool allowUnparsed, out VolumeBackupName result)

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

Parameters
Name	Description
`volumeBackupName`	`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`	`VolumeBackupName` When this method returns, the parsed VolumeBackupName, 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}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(VolumeBackupName, VolumeBackupName)

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

Parameters
Name	Description
`a`	`VolumeBackupName`
`b`	`VolumeBackupName`

Returns
Type	Description
`bool`

operator !=(VolumeBackupName, VolumeBackupName)

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

Parameters
Name	Description
`a`	`VolumeBackupName`
`b`	`VolumeBackupName`

Returns
Type	Description
`bool`