Class VulnerabilityReportName (2.0.0)

public sealed class VulnerabilityReportName : IResourceName, IEquatable<VulnerabilityReportName>

Resource name for the VulnerabilityReport resource.

Inheritance

Object > VulnerabilityReportName

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.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
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.

Properties

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

The VulnerabilityReportName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
VulnerabilityReportName.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)

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

Returns
TypeDescription
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
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.

Returns
TypeDescription
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
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.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
VulnerabilityReportName

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

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

Parameter
NameDescription
vulnerabilityReportNameString

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

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

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

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

The string representation of the resource name.

Overrides

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

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

resultVulnerabilityReportName

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

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

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.

resultVulnerabilityReportName

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

Operators

Equality(VulnerabilityReportName, VulnerabilityReportName)

public static bool operator ==(VulnerabilityReportName a, VulnerabilityReportName b)
Parameters
NameDescription
aVulnerabilityReportName
bVulnerabilityReportName
Returns
TypeDescription
Boolean

Inequality(VulnerabilityReportName, VulnerabilityReportName)

public static bool operator !=(VulnerabilityReportName a, VulnerabilityReportName b)
Parameters
NameDescription
aVulnerabilityReportName
bVulnerabilityReportName
Returns
TypeDescription
Boolean