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.
Namespace
Google.Cloud.GkeBackup.V1Assembly
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 |
locationId |
string The |
backupPlanId |
string The |
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 |
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 BackupPlanName.ResourceNameType Type { get; }
The BackupPlanName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
BackupPlanNameResourceNameType |
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 |
locationId |
string The |
backupPlanId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this BackupPlanName with pattern
|
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 |
locationId |
string The |
backupPlanId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this BackupPlanName with pattern
|
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 |
locationId |
string The |
backupPlanId |
string The |
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 |
Returns | |
---|---|
Type | Description |
BackupPlanName |
A new instance of BackupPlanName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
BackupPlanName |
The parsed BackupPlanName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/backupPlans/{backup_plan}
Parse(string, bool)
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 |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
BackupPlanName |
The parsed BackupPlanName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/backupPlans/{backup_plan}
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. |
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 |
result |
BackupPlanName When this method returns, the parsed BackupPlanName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/backupPlans/{backup_plan}
TryParse(string, bool, 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 |
allowUnparsed |
bool If |
result |
BackupPlanName When this method returns, the parsed BackupPlanName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/backupPlans/{backup_plan}
allowUnparsed
is true
.
Operators
operator ==(BackupPlanName, BackupPlanName)
public static bool operator ==(BackupPlanName a, BackupPlanName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
BackupPlanName The first resource name to compare, or null. |
b |
BackupPlanName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(BackupPlanName, BackupPlanName)
public static bool operator !=(BackupPlanName a, BackupPlanName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
BackupPlanName The first resource name to compare, or null. |
b |
BackupPlanName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |