Backup for GKE v1 API - Class BackupPlanName (2.1.0)

public sealed class BackupPlanName : IResourceName, IEquatable<BackupPlanName>

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

Resource name for the BackupPlan resource.

Inheritance

Object > BackupPlanName

Implements

IResourceName, IEquatable<BackupPlanName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

BackupPlanName(String, String, String)

public BackupPlanName(string projectId, string locationId, string backupPlanId)

Constructs a new instance of a BackupPlanName class from the component parts of pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}

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.

Properties

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

The BackupPlanName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`BackupPlanName.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)

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

Formats the IDs into the string representation of this BackupPlanName with pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}.

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.

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

FormatProjectLocationBackupPlan(String, String, String)

public static string FormatProjectLocationBackupPlan(string projectId, string locationId, string backupPlanId)

Formats the IDs into the string representation of this BackupPlanName with pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}.

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.

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

FromProjectLocationBackupPlan(String, String, String)

public static BackupPlanName FromProjectLocationBackupPlan(string projectId, string locationId, string backupPlanId)

Creates a BackupPlanName with the pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}.

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.

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

FromUnparsed(UnparsedResourceName)

public static BackupPlanName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BackupPlanName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/backupPlans/{backup_plan}

Parse(String, Boolean)

public static BackupPlanName Parse(string backupPlanName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/backupPlans/{backup_plan}

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

public static bool TryParse(string backupPlanName, out BackupPlanName result)

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

Parameters
Name	Description
`backupPlanName`	`String` The resource name in string form. Must not be `null`.
`result`	`BackupPlanName` When this method returns, the parsed BackupPlanName, 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}

TryParse(String, Boolean, out BackupPlanName)

public static bool TryParse(string backupPlanName, bool allowUnparsed, out BackupPlanName result)

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

Parameters
Name	Description
`backupPlanName`	`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`	`BackupPlanName` When this method returns, the parsed BackupPlanName, 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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(BackupPlanName, BackupPlanName)

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

Parameters
Name	Description
`a`	`BackupPlanName`
`b`	`BackupPlanName`

Returns
Type	Description
`Boolean`

Inequality(BackupPlanName, BackupPlanName)

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

Parameters
Name	Description
`a`	`BackupPlanName`
`b`	`BackupPlanName`

Returns
Type	Description
`Boolean`