Google Cloud OS Config v1 API - Class OSPolicyAssignmentName (2.5.0) 

public sealed class OSPolicyAssignmentName : IResourceName, IEquatable<OSPolicyAssignmentName>

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

Resource name for the OSPolicyAssignment resource.

Inheritance

object > OSPolicyAssignmentName

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Constructors

OSPolicyAssignmentName(string, string, string)

public OSPolicyAssignmentName(string projectId, string locationId, string osPolicyAssignmentId)

Constructs a new instance of a OSPolicyAssignmentName class from the component parts of pattern projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}

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.
osPolicyAssignmentId string

The OsPolicyAssignment 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

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

OsPolicyAssignmentId

public string OsPolicyAssignmentId { get; }

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

The OSPolicyAssignmentName.ResourceNameType of the contained resource name.

Property Value
Type Description
OSPolicyAssignmentNameResourceNameType

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

Formats the IDs into the string representation of this OSPolicyAssignmentName with pattern projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}.

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.
osPolicyAssignmentId string

The OsPolicyAssignment ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this OSPolicyAssignmentName with pattern projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}.

FormatProjectLocationOsPolicyAssignment(string, string, string)

public static string FormatProjectLocationOsPolicyAssignment(string projectId, string locationId, string osPolicyAssignmentId)

Formats the IDs into the string representation of this OSPolicyAssignmentName with pattern projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}.

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.
osPolicyAssignmentId string

The OsPolicyAssignment ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this OSPolicyAssignmentName with pattern projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}.

FromProjectLocationOsPolicyAssignment(string, string, string)

public static OSPolicyAssignmentName FromProjectLocationOsPolicyAssignment(string projectId, string locationId, string osPolicyAssignmentId)

Creates a OSPolicyAssignmentName with the pattern projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}.

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.
osPolicyAssignmentId string

The OsPolicyAssignment ID. Must not be null or empty.
Returns
Type Description
OSPolicyAssignmentName

A new instance of OSPolicyAssignmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OSPolicyAssignmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OSPolicyAssignmentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
OSPolicyAssignmentName

A new instance of OSPolicyAssignmentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static OSPolicyAssignmentName Parse(string oSPolicyAssignmentName)

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

Parameter
Name Description
oSPolicyAssignmentName string

The resource name in string form. Must not be null.
Returns
Type Description
OSPolicyAssignmentName

The parsed OSPolicyAssignmentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}

Parse(string, bool)

public static OSPolicyAssignmentName Parse(string oSPolicyAssignmentName, bool allowUnparsed)

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

Parameters
Name Description
oSPolicyAssignmentName 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
OSPolicyAssignmentName

The parsed OSPolicyAssignmentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}
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

TryParse(string, out OSPolicyAssignmentName)

public static bool TryParse(string oSPolicyAssignmentName, out OSPolicyAssignmentName result)

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

Parameters
Name Description
oSPolicyAssignmentName string

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

When this method returns, the parsed OSPolicyAssignmentName, 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}/osPolicyAssignments/{os_policy_assignment}

TryParse(string, bool, out OSPolicyAssignmentName)

public static bool TryParse(string oSPolicyAssignmentName, bool allowUnparsed, out OSPolicyAssignmentName result)

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

Parameters
Name Description
oSPolicyAssignmentName 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 OSPolicyAssignmentName

When this method returns, the parsed OSPolicyAssignmentName, 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}/osPolicyAssignments/{os_policy_assignment}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(OSPolicyAssignmentName, OSPolicyAssignmentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OSPolicyAssignmentName

The first resource name to compare, or null.
b OSPolicyAssignmentName

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 !=(OSPolicyAssignmentName, OSPolicyAssignmentName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OSPolicyAssignmentName

The first resource name to compare, or null.
b OSPolicyAssignmentName

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.