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

public sealed class OSPolicyAssignmentReportName : IResourceName, IEquatable<OSPolicyAssignmentReportName>

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

Resource name for the OSPolicyAssignmentReport resource.

Inheritance

object > OSPolicyAssignmentReportName

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Constructors

OSPolicyAssignmentReportName(string, string, string, string)

public OSPolicyAssignmentReportName(string projectId, string locationId, string instanceId, string assignmentId)

Constructs a new instance of a OSPolicyAssignmentReportName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report

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

The Assignment ID. Must not be null or empty.

Properties

AssignmentId

public string AssignmentId { get; }

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

Property Value
Type Description
string

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 OSPolicyAssignmentReportName.ResourceNameType Type { get; }

The OSPolicyAssignmentReportName.ResourceNameType of the contained resource name.

Property Value
Type Description
OSPolicyAssignmentReportNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string instanceId, string assignmentId)

Formats the IDs into the string representation of this OSPolicyAssignmentReportName with pattern projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report.

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

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

The string representation of this OSPolicyAssignmentReportName with pattern projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report.

FormatProjectLocationInstanceAssignment(string, string, string, string)

public static string FormatProjectLocationInstanceAssignment(string projectId, string locationId, string instanceId, string assignmentId)

Formats the IDs into the string representation of this OSPolicyAssignmentReportName with pattern projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report.

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

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

The string representation of this OSPolicyAssignmentReportName with pattern projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report.

FromProjectLocationInstanceAssignment(string, string, string, string)

public static OSPolicyAssignmentReportName FromProjectLocationInstanceAssignment(string projectId, string locationId, string instanceId, string assignmentId)

Creates a OSPolicyAssignmentReportName with the pattern projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report.

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

The Assignment ID. Must not be null or empty.
Returns
Type Description
OSPolicyAssignmentReportName

A new instance of OSPolicyAssignmentReportName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OSPolicyAssignmentReportName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OSPolicyAssignmentReportName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of OSPolicyAssignmentReportName 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 OSPolicyAssignmentReportName Parse(string oSPolicyAssignmentReportName)

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

Parameter
Name Description
oSPolicyAssignmentReportName string

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

The parsed OSPolicyAssignmentReportName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report

Parse(string, bool)

public static OSPolicyAssignmentReportName Parse(string oSPolicyAssignmentReportName, bool allowUnparsed)

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

Parameters
Name Description
oSPolicyAssignmentReportName 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
OSPolicyAssignmentReportName

The parsed OSPolicyAssignmentReportName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report
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 OSPolicyAssignmentReportName)

public static bool TryParse(string oSPolicyAssignmentReportName, out OSPolicyAssignmentReportName result)

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

Parameters
Name Description
oSPolicyAssignmentReportName string

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

When this method returns, the parsed OSPolicyAssignmentReportName, 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}/instances/{instance}/osPolicyAssignments/{assignment}/report

TryParse(string, bool, out OSPolicyAssignmentReportName)

public static bool TryParse(string oSPolicyAssignmentReportName, bool allowUnparsed, out OSPolicyAssignmentReportName result)

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

Parameters
Name Description
oSPolicyAssignmentReportName 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 OSPolicyAssignmentReportName

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

Operators

operator ==(OSPolicyAssignmentReportName, OSPolicyAssignmentReportName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OSPolicyAssignmentReportName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OSPolicyAssignmentReportName

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

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.