Backup for GKE v1 API - Class BackupName (2.1.0)

public sealed class BackupName : IResourceName, IEquatable<BackupName>

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

Resource name for the Backup resource.

Inheritance

Object > BackupName

Implements

IResourceName, IEquatable<BackupName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

BackupName(String, String, String, String)

public BackupName(string projectId, string locationId, string backupPlanId, string backupId)

Constructs a new instance of a BackupName class from the component parts of pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{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.

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
`Boolean`

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

The BackupName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`BackupName.ResourceNameType`

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, String)

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

Formats the IDs into the string representation of this BackupName with pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{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.

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

FormatProjectLocationBackupPlanBackup(String, String, String, String)

public static string FormatProjectLocationBackupPlanBackup(string projectId, string locationId, string backupPlanId, string backupId)

Formats the IDs into the string representation of this BackupName with pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{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.

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

FromProjectLocationBackupPlanBackup(String, String, String, String)

public static BackupName FromProjectLocationBackupPlanBackup(string projectId, string locationId, string backupPlanId, string backupId)

Creates a BackupName with the pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{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.

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

FromUnparsed(UnparsedResourceName)

public static BackupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BackupName containing an unparsed resource name.

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

Returns
Type	Description
`BackupName`	A new instance of BackupName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static BackupName Parse(string backupName)

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

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

Returns
Type	Description
`BackupName`	The parsed BackupName 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}

Parse(String, Boolean)

public static BackupName Parse(string backupName, bool allowUnparsed)

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

Parameters
Name	Description
`backupName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`BackupName`	The parsed BackupName 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}

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

public static bool TryParse(string backupName, out BackupName result)

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

Parameters
Name	Description
`backupName`	`String` The resource name in string form. Must not be `null`.
`result`	`BackupName` When this method returns, the parsed BackupName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}

TryParse(String, Boolean, out BackupName)

public static bool TryParse(string backupName, bool allowUnparsed, out BackupName result)

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

Parameters
Name	Description
`backupName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`BackupName` When this method returns, the parsed BackupName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(BackupName, BackupName)

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

Parameters
Name	Description
`a`	`BackupName`
`b`	`BackupName`

Returns
Type	Description
`Boolean`

Inequality(BackupName, BackupName)

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

Parameters
Name	Description
`a`	`BackupName`
`b`	`BackupName`

Returns
Type	Description
`Boolean`