Google Cloud OS Config v1alpha API - Class InstanceOSPoliciesComplianceName (2.0.0-alpha03)

Version 2.0.0-alpha03

• 2.0.0-alpha06 (latest)
• 2.0.0-alpha05
• 1.0.0-alpha04

public sealed class InstanceOSPoliciesComplianceName : IResourceName, IEquatable<InstanceOSPoliciesComplianceName>

Reference documentation and code samples for the Google Cloud OS Config v1alpha API class InstanceOSPoliciesComplianceName.

Resource name for the InstanceOSPoliciesCompliance resource.

Inheritance

object > InstanceOSPoliciesComplianceName

Implements

IResourceName, IEquatableInstanceOSPoliciesComplianceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.OsConfig.V1Alpha

Assembly

Google.Cloud.OsConfig.V1Alpha.dll

Constructors

InstanceOSPoliciesComplianceName(string, string, string)

public InstanceOSPoliciesComplianceName(string projectId, string locationId, string instanceId)

Constructs a new instance of a InstanceOSPoliciesComplianceName class from the component parts of pattern projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}

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.
instanceId	string The Instance ID. Must not be null or empty.

Properties

InstanceId

public string InstanceId { get; }

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

Property Value
Type	Description
string

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

Type

public InstanceOSPoliciesComplianceName.ResourceNameType Type { get; }

The InstanceOSPoliciesComplianceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
InstanceOSPoliciesComplianceNameResourceNameType

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

Formats the IDs into the string representation of this InstanceOSPoliciesComplianceName with pattern projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}.

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.
instanceId	string The Instance ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this InstanceOSPoliciesComplianceName with pattern projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}.

FormatProjectLocationInstance(string, string, string)

public static string FormatProjectLocationInstance(string projectId, string locationId, string instanceId)

Formats the IDs into the string representation of this InstanceOSPoliciesComplianceName with pattern projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}.

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.
instanceId	string The Instance ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this InstanceOSPoliciesComplianceName with pattern projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}.

FromProjectLocationInstance(string, string, string)

public static InstanceOSPoliciesComplianceName FromProjectLocationInstance(string projectId, string locationId, string instanceId)

Creates a InstanceOSPoliciesComplianceName with the pattern projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}.

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.
instanceId	string The Instance ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static InstanceOSPoliciesComplianceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InstanceOSPoliciesComplianceName containing an unparsed resource name.

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

Returns
Type	Description
InstanceOSPoliciesComplianceName	A new instance of InstanceOSPoliciesComplianceName 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 InstanceOSPoliciesComplianceName Parse(string instanceOSPoliciesComplianceName)

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

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

Returns
Type	Description
InstanceOSPoliciesComplianceName	The parsed InstanceOSPoliciesComplianceName if successful.

Remarks

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

• projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}

Parse(string, bool)

public static InstanceOSPoliciesComplianceName Parse(string instanceOSPoliciesComplianceName, bool allowUnparsed)

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

Parameters
Name	Description
instanceOSPoliciesComplianceName	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
InstanceOSPoliciesComplianceName	The parsed InstanceOSPoliciesComplianceName if successful.

Remarks

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

• projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}

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

public static bool TryParse(string instanceOSPoliciesComplianceName, out InstanceOSPoliciesComplianceName result)

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

Parameters
Name	Description
instanceOSPoliciesComplianceName	string The resource name in string form. Must not be null.
result	InstanceOSPoliciesComplianceName When this method returns, the parsed InstanceOSPoliciesComplianceName, 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}/instanceOSPoliciesCompliances/{instance}

TryParse(string, bool, out InstanceOSPoliciesComplianceName)

public static bool TryParse(string instanceOSPoliciesComplianceName, bool allowUnparsed, out InstanceOSPoliciesComplianceName result)

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

Parameters
Name	Description
instanceOSPoliciesComplianceName	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	InstanceOSPoliciesComplianceName When this method returns, the parsed InstanceOSPoliciesComplianceName, 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}/instanceOSPoliciesCompliances/{instance}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(InstanceOSPoliciesComplianceName, InstanceOSPoliciesComplianceName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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