public sealed class RestoreName : IResourceName, IEquatable<RestoreName>
Resource name for the Restore
resource.
Namespace
Google.Cloud.GkeBackup.V1Assembly
Google.Cloud.GkeBackup.V1.dll
Constructors
RestoreName(String, String, String, String)
public RestoreName(string projectId, string locationId, string restorePlanId, string restoreId)
Constructs a new instance of a RestoreName class from the component parts of pattern
projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
restorePlanId | String The |
restoreId | String The |
Properties
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 |
RestoreId
public string RestoreId { get; }
The Restore
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
String |
RestorePlanId
public string RestorePlanId { get; }
The RestorePlan
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
String |
Type
public RestoreName.ResourceNameType Type { get; }
The RestoreName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
RestoreName.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, String)
public static string Format(string projectId, string locationId, string restorePlanId, string restoreId)
Formats the IDs into the string representation of this RestoreName with pattern
projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
restorePlanId | String The |
restoreId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this RestoreName with pattern
|
FormatProjectLocationRestorePlanRestore(String, String, String, String)
public static string FormatProjectLocationRestorePlanRestore(string projectId, string locationId, string restorePlanId, string restoreId)
Formats the IDs into the string representation of this RestoreName with pattern
projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
restorePlanId | String The |
restoreId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this RestoreName with pattern
|
FromProjectLocationRestorePlanRestore(String, String, String, String)
public static RestoreName FromProjectLocationRestorePlanRestore(string projectId, string locationId, string restorePlanId, string restoreId)
Creates a RestoreName with the pattern
projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
restorePlanId | String The |
restoreId | String The |
Returns | |
---|---|
Type | Description |
RestoreName | A new instance of RestoreName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static RestoreName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a RestoreName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
RestoreName | A new instance of RestoreName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
Parse(String)
public static RestoreName Parse(string restoreName)
Parses the given resource name string into a new RestoreName instance.
Parameter | |
---|---|
Name | Description |
restoreName | String The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
RestoreName | The parsed RestoreName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
Parse(String, Boolean)
public static RestoreName Parse(string restoreName, bool allowUnparsed)
Parses the given resource name string into a new RestoreName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
restoreName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
RestoreName | The parsed RestoreName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
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 RestoreName)
public static bool TryParse(string restoreName, out RestoreName result)
Tries to parse the given resource name string into a new RestoreName instance.
Parameters | |
---|---|
Name | Description |
restoreName | String The resource name in string form. Must not be |
result | RestoreName When this method returns, the parsed RestoreName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
TryParse(String, Boolean, out RestoreName)
public static bool TryParse(string restoreName, bool allowUnparsed, out RestoreName result)
Tries to parse the given resource name string into a new RestoreName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
restoreName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | RestoreName When this method returns, the parsed RestoreName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
allowUnparsed
is true
.
Operators
Equality(RestoreName, RestoreName)
public static bool operator ==(RestoreName a, RestoreName b)
Parameters | |
---|---|
Name | Description |
a | RestoreName |
b | RestoreName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(RestoreName, RestoreName)
public static bool operator !=(RestoreName a, RestoreName b)
Parameters | |
---|---|
Name | Description |
a | RestoreName |
b | RestoreName |
Returns | |
---|---|
Type | Description |
Boolean |