Google Cloud OS Config v1 API - Class PatchDeploymentName (2.3.0)

public sealed class PatchDeploymentName : IResourceName, IEquatable<PatchDeploymentName>

Reference documentation and code samples for the Google Cloud OS Config v1 API class PatchDeploymentName.

Resource name for the PatchDeployment resource.

Inheritance

object > PatchDeploymentName

Implements

IResourceName, IEquatable PatchDeploymentName

Inherited Members

object.GetType()

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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`patchDeploymentId`	`string` 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
Type	Description
`bool`

PatchDeploymentId

public string PatchDeploymentId { get; }

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

The PatchDeploymentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`PatchDeploymentNameResourceNameType`

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)

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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`patchDeploymentId`	`string` The `PatchDeployment` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`patchDeploymentId`	`string` The `PatchDeployment` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`patchDeploymentId`	`string` The `PatchDeployment` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`PatchDeploymentName`	A new instance of PatchDeploymentName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static PatchDeploymentName Parse(string patchDeploymentName)

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

Parameter
Name	Description
`patchDeploymentName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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, bool)

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
Name	Description
`patchDeploymentName`	`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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`patchDeploymentName`	`string` The resource name in string form. Must not be `null`.
`result`	`PatchDeploymentName` When this method returns, the parsed PatchDeploymentName, 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}/patchDeployments/{patch_deployment}

TryParse(string, bool, 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
Name	Description
`patchDeploymentName`	`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`	`PatchDeploymentName` When this method returns, the parsed PatchDeploymentName, 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}/patchDeployments/{patch_deployment}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PatchDeploymentName, PatchDeploymentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`PatchDeploymentName` The first resource name to compare, or null.
`b`	`PatchDeploymentName` 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 !=(PatchDeploymentName, PatchDeploymentName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`PatchDeploymentName` The first resource name to compare, or null.
`b`	`PatchDeploymentName` 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.