Class OSPolicyAssignmentReportName

public sealed class OSPolicyAssignmentReportName : IResourceName, IEquatable<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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

assignmentIdString

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

InstanceId

public string InstanceId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

The OSPolicyAssignmentReportName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
OSPolicyAssignmentReportName.ResourceNameType

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, 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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

assignmentIdString

The Assignment ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

assignmentIdString

The Assignment ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

assignmentIdString

The Assignment ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
OSPolicyAssignmentReportName

A new instance of OSPolicyAssignmentReportName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static OSPolicyAssignmentReportName Parse(string oSPolicyAssignmentReportName)

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

Parameter
NameDescription
oSPolicyAssignmentReportNameString

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

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

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

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

allowUnparsedBoolean

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
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
TypeDescription
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
NameDescription
oSPolicyAssignmentReportNameString

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

resultOSPolicyAssignmentReportName

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

Returns
TypeDescription
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}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report

TryParse(String, Boolean, 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
NameDescription
oSPolicyAssignmentReportNameString

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

allowUnparsedBoolean

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.

resultOSPolicyAssignmentReportName

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

Returns
TypeDescription
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}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report
Or may be in any format if allowUnparsed is true.

Operators

Equality(OSPolicyAssignmentReportName, OSPolicyAssignmentReportName)

public static bool operator ==(OSPolicyAssignmentReportName a, OSPolicyAssignmentReportName b)
Parameters
NameDescription
aOSPolicyAssignmentReportName
bOSPolicyAssignmentReportName
Returns
TypeDescription
Boolean

Inequality(OSPolicyAssignmentReportName, OSPolicyAssignmentReportName)

public static bool operator !=(OSPolicyAssignmentReportName a, OSPolicyAssignmentReportName b)
Parameters
NameDescription
aOSPolicyAssignmentReportName
bOSPolicyAssignmentReportName
Returns
TypeDescription
Boolean