Class PatchDeploymentName (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class PatchDeploymentName : IResourceName, IEquatable<PatchDeploymentName>

Resource name for the PatchDeployment resource.

Inheritance

Object > PatchDeploymentName

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Constructors

PatchDeploymentName(String, String)

public PatchDeploymentName(string projectId, string patchDeploymentId)

Constructs a new instance of a PatchDeploymentName class from the component parts of pattern projects/{project}/patchDeployments/{patch_deployment}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

patchDeploymentIdString

The PatchDeployment 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
TypeDescription
Boolean

PatchDeploymentId

public string PatchDeploymentId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public PatchDeploymentName.ResourceNameType Type { get; }

The PatchDeploymentName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
PatchDeploymentName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String)

public static string Format(string projectId, string patchDeploymentId)

Formats the IDs into the string representation of this PatchDeploymentName with pattern projects/{project}/patchDeployments/{patch_deployment}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

patchDeploymentIdString

The PatchDeployment ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this PatchDeploymentName with pattern projects/{project}/patchDeployments/{patch_deployment}.

FormatProjectPatchDeployment(String, String)

public static string FormatProjectPatchDeployment(string projectId, string patchDeploymentId)

Formats the IDs into the string representation of this PatchDeploymentName with pattern projects/{project}/patchDeployments/{patch_deployment}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

patchDeploymentIdString

The PatchDeployment ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this PatchDeploymentName with pattern projects/{project}/patchDeployments/{patch_deployment}.

FromProjectPatchDeployment(String, String)

public static PatchDeploymentName FromProjectPatchDeployment(string projectId, string patchDeploymentId)

Creates a PatchDeploymentName with the pattern projects/{project}/patchDeployments/{patch_deployment}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

patchDeploymentIdString

The PatchDeployment ID. Must not be null or empty.

Returns
TypeDescription
PatchDeploymentName

A new instance of PatchDeploymentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PatchDeploymentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PatchDeploymentName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
PatchDeploymentName

A new instance of PatchDeploymentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static PatchDeploymentName Parse(string patchDeploymentName)

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

Parameter
NameDescription
patchDeploymentNameString

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

Returns
TypeDescription
PatchDeploymentName

The parsed PatchDeploymentName if successful.

Remarks

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

  • projects/{project}/patchDeployments/{patch_deployment}

Parse(String, Boolean)

public static PatchDeploymentName Parse(string patchDeploymentName, bool allowUnparsed)

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

Parameters
NameDescription
patchDeploymentNameString

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

allowUnparsedBoolean

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
TypeDescription
PatchDeploymentName

The parsed PatchDeploymentName if successful.

Remarks

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

  • projects/{project}/patchDeployments/{patch_deployment}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out PatchDeploymentName)

public static bool TryParse(string patchDeploymentName, out PatchDeploymentName result)

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

Parameters
NameDescription
patchDeploymentNameString

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

resultPatchDeploymentName

When this method returns, the parsed PatchDeploymentName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/patchDeployments/{patch_deployment}

TryParse(String, Boolean, out PatchDeploymentName)

public static bool TryParse(string patchDeploymentName, bool allowUnparsed, out PatchDeploymentName result)

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

Parameters
NameDescription
patchDeploymentNameString

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

allowUnparsedBoolean

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.

resultPatchDeploymentName

When this method returns, the parsed PatchDeploymentName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/patchDeployments/{patch_deployment}
Or may be in any format if allowUnparsed is true.

Operators

Equality(PatchDeploymentName, PatchDeploymentName)

public static bool operator ==(PatchDeploymentName a, PatchDeploymentName b)
Parameters
NameDescription
aPatchDeploymentName
bPatchDeploymentName
Returns
TypeDescription
Boolean

Inequality(PatchDeploymentName, PatchDeploymentName)

public static bool operator !=(PatchDeploymentName a, PatchDeploymentName b)
Parameters
NameDescription
aPatchDeploymentName
bPatchDeploymentName
Returns
TypeDescription
Boolean