Google Cloud OS Config v1 API - Class PatchJobName (2.1.0)

public sealed class PatchJobName : IResourceName, IEquatable<PatchJobName>

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

Resource name for the PatchJob resource.

Inheritance

Object > PatchJobName

Implements

IResourceName, IEquatable<PatchJobName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Constructors

PatchJobName(String, String)

public PatchJobName(string projectId, string patchJobId)

Constructs a new instance of a PatchJobName class from the component parts of pattern projects/{project}/patchJobs/{patch_job}

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`patchJobId`	`String` The `PatchJob` 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
`Boolean`

PatchJobId

public string PatchJobId { get; }

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

The PatchJobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`PatchJobName.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)

public static string Format(string projectId, string patchJobId)

Formats the IDs into the string representation of this PatchJobName with pattern projects/{project}/patchJobs/{patch_job}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`patchJobId`	`String` The `PatchJob` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this PatchJobName with pattern `projects/{project}/patchJobs/{patch_job}`.

FormatProjectPatchJob(String, String)

public static string FormatProjectPatchJob(string projectId, string patchJobId)

Formats the IDs into the string representation of this PatchJobName with pattern projects/{project}/patchJobs/{patch_job}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`patchJobId`	`String` The `PatchJob` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this PatchJobName with pattern `projects/{project}/patchJobs/{patch_job}`.

FromProjectPatchJob(String, String)

public static PatchJobName FromProjectPatchJob(string projectId, string patchJobId)

Creates a PatchJobName with the pattern projects/{project}/patchJobs/{patch_job}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`patchJobId`	`String` The `PatchJob` ID. Must not be `null` or empty.

Returns
Type	Description
`PatchJobName`	A new instance of PatchJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PatchJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PatchJobName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static PatchJobName Parse(string patchJobName)

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

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

Returns
Type	Description
`PatchJobName`	The parsed PatchJobName if successful.

Remarks

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

projects/{project}/patchJobs/{patch_job}

Parse(String, Boolean)

public static PatchJobName Parse(string patchJobName, bool allowUnparsed)

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

Parameters
Name	Description
`patchJobName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`PatchJobName`	The parsed PatchJobName if successful.

Remarks

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

projects/{project}/patchJobs/{patch_job}

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

public static bool TryParse(string patchJobName, out PatchJobName result)

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

Parameters
Name	Description
`patchJobName`	`String` The resource name in string form. Must not be `null`.
`result`	`PatchJobName` When this method returns, the parsed PatchJobName, or `null` if parsing failed.

Returns
Type	Description
`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}/patchJobs/{patch_job}

TryParse(String, Boolean, out PatchJobName)

public static bool TryParse(string patchJobName, bool allowUnparsed, out PatchJobName result)

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

Parameters
Name	Description
`patchJobName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`PatchJobName` When this method returns, the parsed PatchJobName, or `null` if parsing failed.

Returns
Type	Description
`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}/patchJobs/{patch_job}

Or may be in any format if allowUnparsed is true.

Operators

Equality(PatchJobName, PatchJobName)

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

Parameters
Name	Description
`a`	`PatchJobName`
`b`	`PatchJobName`

Returns
Type	Description
`Boolean`

Inequality(PatchJobName, PatchJobName)

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

Parameters
Name	Description
`a`	`PatchJobName`
`b`	`PatchJobName`

Returns
Type	Description
`Boolean`