Google Cloud OS Config v1 API - Class PatchJobName (2.2.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

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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

patchJobIdstring

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

PatchJobId

public string PatchJobId { get; }

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

The PatchJobName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
PatchJobNameResourceNameType

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

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

patchJobIdstring

The PatchJob ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

patchJobIdstring

The PatchJob ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

patchJobIdstring

The PatchJob ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
PatchJobName

A new instance of PatchJobName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static PatchJobName Parse(string patchJobName)

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

Parameter
NameDescription
patchJobNamestring

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

Returns
TypeDescription
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, bool)

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
NameDescription
patchJobNamestring

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

allowUnparsedbool

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

The string representation of the resource name.

Overrides

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
NameDescription
patchJobNamestring

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

resultPatchJobName

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

Returns
TypeDescription
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}/patchJobs/{patch_job}

TryParse(string, bool, 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
NameDescription
patchJobNamestring

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

allowUnparsedbool

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.

resultPatchJobName

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

Returns
TypeDescription
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}/patchJobs/{patch_job}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PatchJobName, PatchJobName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aPatchJobName

The first resource name to compare, or null.

bPatchJobName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(PatchJobName, PatchJobName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aPatchJobName

The first resource name to compare, or null.

bPatchJobName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.