Backup and DR Service v1beta API - Class AppliedAutoProtectionPolicyName (1.0.0-beta01) 

public sealed class AppliedAutoProtectionPolicyName : IResourceName, IEquatable<AppliedAutoProtectionPolicyName>

Reference documentation and code samples for the Backup and DR Service v1beta API class AppliedAutoProtectionPolicyName.

Resource name for the AppliedAutoProtectionPolicy resource.

Inheritance

object > AppliedAutoProtectionPolicyName

Namespace

Google.Cloud.BackupDR.V1Beta

Assembly

Google.Cloud.BackupDR.V1Beta.dll

Constructors

AppliedAutoProtectionPolicyName(string, string, string)

public AppliedAutoProtectionPolicyName(string projectId, string locationId, string appliedAutoProtectionPolicyId)

Constructs a new instance of a AppliedAutoProtectionPolicyName class from the component parts of pattern projects/{project}/locations/{location}/appliedAutoProtectionPolicies/{applied_auto_protection_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.
appliedAutoProtectionPolicyId string

The AppliedAutoProtectionPolicy ID. Must not be null or empty.

Properties

AppliedAutoProtectionPolicyId

public string AppliedAutoProtectionPolicyId { get; }

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

The AppliedAutoProtectionPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
AppliedAutoProtectionPolicyNameResourceNameType

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

Formats the IDs into the string representation of this AppliedAutoProtectionPolicyName with pattern projects/{project}/locations/{location}/appliedAutoProtectionPolicies/{applied_auto_protection_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.
appliedAutoProtectionPolicyId string

The AppliedAutoProtectionPolicy ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AppliedAutoProtectionPolicyName with pattern projects/{project}/locations/{location}/appliedAutoProtectionPolicies/{applied_auto_protection_policy} .

FormatProjectLocationAppliedAutoProtectionPolicy(string, string, string)

public static string FormatProjectLocationAppliedAutoProtectionPolicy(string projectId, string locationId, string appliedAutoProtectionPolicyId)

Formats the IDs into the string representation of this AppliedAutoProtectionPolicyName with pattern projects/{project}/locations/{location}/appliedAutoProtectionPolicies/{applied_auto_protection_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.
appliedAutoProtectionPolicyId string

The AppliedAutoProtectionPolicy ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AppliedAutoProtectionPolicyName with pattern projects/{project}/locations/{location}/appliedAutoProtectionPolicies/{applied_auto_protection_policy} .

FromProjectLocationAppliedAutoProtectionPolicy(string, string, string)

public static AppliedAutoProtectionPolicyName FromProjectLocationAppliedAutoProtectionPolicy(string projectId, string locationId, string appliedAutoProtectionPolicyId)

Creates a AppliedAutoProtectionPolicyName with the pattern projects/{project}/locations/{location}/appliedAutoProtectionPolicies/{applied_auto_protection_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.
appliedAutoProtectionPolicyId string

The AppliedAutoProtectionPolicy ID. Must not be null or empty.
Returns
Type Description
AppliedAutoProtectionPolicyName

A new instance of AppliedAutoProtectionPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AppliedAutoProtectionPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AppliedAutoProtectionPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
AppliedAutoProtectionPolicyName

A new instance of AppliedAutoProtectionPolicyName 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 AppliedAutoProtectionPolicyName Parse(string appliedAutoProtectionPolicyName)

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

Parameter
Name Description
appliedAutoProtectionPolicyName string

The resource name in string form. Must not be null.
Returns
Type Description
AppliedAutoProtectionPolicyName

The parsed AppliedAutoProtectionPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/appliedAutoProtectionPolicies/{applied_auto_protection_policy}

Parse(string, bool)

public static AppliedAutoProtectionPolicyName Parse(string appliedAutoProtectionPolicyName, bool allowUnparsed)

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

Parameters
Name Description
appliedAutoProtectionPolicyName 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
AppliedAutoProtectionPolicyName

The parsed AppliedAutoProtectionPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/appliedAutoProtectionPolicies/{applied_auto_protection_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 AppliedAutoProtectionPolicyName)

public static bool TryParse(string appliedAutoProtectionPolicyName, out AppliedAutoProtectionPolicyName result)

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

Parameters
Name Description
appliedAutoProtectionPolicyName string

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

When this method returns, the parsed AppliedAutoProtectionPolicyName, 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}/appliedAutoProtectionPolicies/{applied_auto_protection_policy}

TryParse(string, bool, out AppliedAutoProtectionPolicyName)

public static bool TryParse(string appliedAutoProtectionPolicyName, bool allowUnparsed, out AppliedAutoProtectionPolicyName result)

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

Parameters
Name Description
appliedAutoProtectionPolicyName 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 AppliedAutoProtectionPolicyName

When this method returns, the parsed AppliedAutoProtectionPolicyName, 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}/appliedAutoProtectionPolicies/{applied_auto_protection_policy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AppliedAutoProtectionPolicyName, AppliedAutoProtectionPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AppliedAutoProtectionPolicyName

The first resource name to compare, or null.
b AppliedAutoProtectionPolicyName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AppliedAutoProtectionPolicyName

The first resource name to compare, or null.
b AppliedAutoProtectionPolicyName

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.