Maintenance v1beta API - Class ResourceMaintenanceName (1.0.0-beta01) 

public sealed class ResourceMaintenanceName : IResourceName, IEquatable<ResourceMaintenanceName>

Reference documentation and code samples for the Maintenance v1beta API class ResourceMaintenanceName.

Resource name for the ResourceMaintenance resource.

Inheritance

object > ResourceMaintenanceName

Namespace

Google.Cloud.Maintenance.Api.V1Beta

Assembly

Google.Cloud.Maintenance.Api.V1Beta.dll

Constructors

ResourceMaintenanceName(string, string, string)

public ResourceMaintenanceName(string projectId, string locationId, string resourceMaintenanceId)

Constructs a new instance of a ResourceMaintenanceName class from the component parts of pattern projects/{project}/locations/{location}/resourceMaintenances/{resource_maintenance}

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.
resourceMaintenanceId string

The ResourceMaintenance ID. Must not be null or empty.

Properties

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

ResourceMaintenanceId

public string ResourceMaintenanceId { get; }

The ResourceMaintenance ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public ResourceMaintenanceName.ResourceNameType Type { get; }

The ResourceMaintenanceName.ResourceNameType of the contained resource name.

Property Value
Type Description
ResourceMaintenanceNameResourceNameType

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

Formats the IDs into the string representation of this ResourceMaintenanceName with pattern projects/{project}/locations/{location}/resourceMaintenances/{resource_maintenance}.

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.
resourceMaintenanceId string

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

The string representation of this ResourceMaintenanceName with pattern projects/{project}/locations/{location}/resourceMaintenances/{resource_maintenance}.

FormatProjectLocationResourceMaintenance(string, string, string)

public static string FormatProjectLocationResourceMaintenance(string projectId, string locationId, string resourceMaintenanceId)

Formats the IDs into the string representation of this ResourceMaintenanceName with pattern projects/{project}/locations/{location}/resourceMaintenances/{resource_maintenance}.

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.
resourceMaintenanceId string

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

The string representation of this ResourceMaintenanceName with pattern projects/{project}/locations/{location}/resourceMaintenances/{resource_maintenance}.

FromProjectLocationResourceMaintenance(string, string, string)

public static ResourceMaintenanceName FromProjectLocationResourceMaintenance(string projectId, string locationId, string resourceMaintenanceId)

Creates a ResourceMaintenanceName with the pattern projects/{project}/locations/{location}/resourceMaintenances/{resource_maintenance}.

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.
resourceMaintenanceId string

The ResourceMaintenance ID. Must not be null or empty.
Returns
Type Description
ResourceMaintenanceName

A new instance of ResourceMaintenanceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ResourceMaintenanceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ResourceMaintenanceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
resourceMaintenanceName string

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

The parsed ResourceMaintenanceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/resourceMaintenances/{resource_maintenance}

Parse(string, bool)

public static ResourceMaintenanceName Parse(string resourceMaintenanceName, bool allowUnparsed)

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

Parameters
Name Description
resourceMaintenanceName 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
ResourceMaintenanceName

The parsed ResourceMaintenanceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/resourceMaintenances/{resource_maintenance}
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 ResourceMaintenanceName)

public static bool TryParse(string resourceMaintenanceName, out ResourceMaintenanceName result)

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

Parameters
Name Description
resourceMaintenanceName string

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

When this method returns, the parsed ResourceMaintenanceName, 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}/resourceMaintenances/{resource_maintenance}

TryParse(string, bool, out ResourceMaintenanceName)

public static bool TryParse(string resourceMaintenanceName, bool allowUnparsed, out ResourceMaintenanceName result)

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

Parameters
Name Description
resourceMaintenanceName 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 ResourceMaintenanceName

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

Operators

operator ==(ResourceMaintenanceName, ResourceMaintenanceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ResourceMaintenanceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ResourceMaintenanceName

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

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.