NetApp v1 API - Class BackupPolicyName (1.3.0)

public sealed class BackupPolicyName : IResourceName, IEquatable<BackupPolicyName>

Reference documentation and code samples for the NetApp v1 API class BackupPolicyName.

Resource name for the BackupPolicy resource.

Inheritance

object > BackupPolicyName

Namespace

Google.Cloud.NetApp.V1

Assembly

Google.Cloud.NetApp.V1.dll

Constructors

BackupPolicyName(string, string, string)

public BackupPolicyName(string projectId, string locationId, string backupPolicyId)

Constructs a new instance of a BackupPolicyName class from the component parts of pattern projects/{project}/locations/{location}/backupPolicies/{backup_policy}

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.

backupPolicyId string

The BackupPolicy ID. Must not be null or empty.

Properties

BackupPolicyId

public string BackupPolicyId { get; }

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

The BackupPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
BackupPolicyNameResourceNameType

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

Formats the IDs into the string representation of this BackupPolicyName with pattern projects/{project}/locations/{location}/backupPolicies/{backup_policy}.

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.

backupPolicyId string

The BackupPolicy ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this BackupPolicyName with pattern projects/{project}/locations/{location}/backupPolicies/{backup_policy}.

FormatProjectLocationBackupPolicy(string, string, string)

public static string FormatProjectLocationBackupPolicy(string projectId, string locationId, string backupPolicyId)

Formats the IDs into the string representation of this BackupPolicyName with pattern projects/{project}/locations/{location}/backupPolicies/{backup_policy}.

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.

backupPolicyId string

The BackupPolicy ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this BackupPolicyName with pattern projects/{project}/locations/{location}/backupPolicies/{backup_policy}.

FromProjectLocationBackupPolicy(string, string, string)

public static BackupPolicyName FromProjectLocationBackupPolicy(string projectId, string locationId, string backupPolicyId)

Creates a BackupPolicyName with the pattern projects/{project}/locations/{location}/backupPolicies/{backup_policy}.

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.

backupPolicyId string

The BackupPolicy ID. Must not be null or empty.

Returns
Type Description
BackupPolicyName

A new instance of BackupPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BackupPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BackupPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
BackupPolicyName

A new instance of BackupPolicyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static BackupPolicyName Parse(string backupPolicyName)

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

Parameter
Name Description
backupPolicyName string

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

Returns
Type Description
BackupPolicyName

The parsed BackupPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/backupPolicies/{backup_policy}

Parse(string, bool)

public static BackupPolicyName Parse(string backupPolicyName, bool allowUnparsed)

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

Parameters
Name Description
backupPolicyName 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
BackupPolicyName

The parsed BackupPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/backupPolicies/{backup_policy}
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

TryParse(string, out BackupPolicyName)

public static bool TryParse(string backupPolicyName, out BackupPolicyName result)

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

Parameters
Name Description
backupPolicyName string

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

result BackupPolicyName

When this method returns, the parsed BackupPolicyName, 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}/backupPolicies/{backup_policy}

TryParse(string, bool, out BackupPolicyName)

public static bool TryParse(string backupPolicyName, bool allowUnparsed, out BackupPolicyName result)

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

Parameters
Name Description
backupPolicyName 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 BackupPolicyName

When this method returns, the parsed BackupPolicyName, 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}/backupPolicies/{backup_policy}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(BackupPolicyName, BackupPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BackupPolicyName

The first resource name to compare, or null.

b BackupPolicyName

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 !=(BackupPolicyName, BackupPolicyName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BackupPolicyName

The first resource name to compare, or null.

b BackupPolicyName

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.