Google Cloud OS Config v1alpha API - Class VulnerabilityReportName (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 VulnerabilityReportName : IResourceName, IEquatable<VulnerabilityReportName>

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

Resource name for the VulnerabilityReport resource.

Inheritance

object > VulnerabilityReportName

Implements

IResourceName, IEquatableVulnerabilityReportName

Inherited Members

object.GetType()

Namespace

Google.Cloud.OsConfig.V1Alpha

Assembly

Google.Cloud.OsConfig.V1Alpha.dll

Constructors

VulnerabilityReportName(string, string, string)

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

Constructs a new instance of a VulnerabilityReportName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport

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

The VulnerabilityReportName.ResourceNameType of the contained resource name.

Property Value
Type	Description
VulnerabilityReportNameResourceNameType

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 VulnerabilityReportName with pattern projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport.

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 VulnerabilityReportName with pattern projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport.

FormatProjectLocationInstance(string, string, string)

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

Formats the IDs into the string representation of this VulnerabilityReportName with pattern projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport.

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 VulnerabilityReportName with pattern projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport.

FromProjectLocationInstance(string, string, string)

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

Creates a VulnerabilityReportName with the pattern projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport.

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
VulnerabilityReportName	A new instance of VulnerabilityReportName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VulnerabilityReportName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VulnerabilityReportName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
VulnerabilityReportName	The parsed VulnerabilityReportName if successful.

Remarks

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

• projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport

Parse(string, bool)

public static VulnerabilityReportName Parse(string vulnerabilityReportName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport

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

public static bool TryParse(string vulnerabilityReportName, out VulnerabilityReportName result)

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

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

TryParse(string, bool, out VulnerabilityReportName)

public static bool TryParse(string vulnerabilityReportName, bool allowUnparsed, out VulnerabilityReportName result)

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

Parameters
Name	Description
vulnerabilityReportName	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	VulnerabilityReportName When this method returns, the parsed VulnerabilityReportName, 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}/vulnerabilityReport

Or may be in any format if allowUnparsed is true.

Operators

operator ==(VulnerabilityReportName, VulnerabilityReportName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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