Backup for GKE v1 API - Class BackupName (2.4.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

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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

backupPlanIdstring

The BackupPlan ID. Must not be null or empty.

backupIdstring

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
TypeDescription
string

BackupPlanId

public string BackupPlanId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public BackupName.ResourceNameType Type { get; }

The BackupName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
BackupNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

backupPlanIdstring

The BackupPlan ID. Must not be null or empty.

backupIdstring

The Backup ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

backupPlanIdstring

The BackupPlan ID. Must not be null or empty.

backupIdstring

The Backup ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

backupPlanIdstring

The BackupPlan ID. Must not be null or empty.

backupIdstring

The Backup ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
BackupName

A new instance of BackupName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static BackupName Parse(string backupName)

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

Parameter
NameDescription
backupNamestring

The resource name in string form. Must not be null.

Returns
TypeDescription
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, bool)

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
NameDescription
backupNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

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
TypeDescription
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
TypeDescription
string

The string representation of the resource name.

Overrides

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
NameDescription
backupNamestring

The resource name in string form. Must not be null.

resultBackupName

When this method returns, the parsed BackupName, or null if parsing failed.

Returns
TypeDescription
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}

TryParse(string, bool, 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
NameDescription
backupNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

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.

resultBackupName

When this method returns, the parsed BackupName, or null if parsing failed.

Returns
TypeDescription
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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(BackupName, BackupName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aBackupName

The first resource name to compare, or null.

bBackupName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(BackupName, BackupName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aBackupName

The first resource name to compare, or null.

bBackupName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.