Cloud Storage v2 API - Class IntelligenceFindingName (1.8.0)

public sealed class IntelligenceFindingName : IResourceName, IEquatable<IntelligenceFindingName>

Reference documentation and code samples for the Cloud Storage v2 API class IntelligenceFindingName.

Resource name for the IntelligenceFinding resource.

Inheritance

object > IntelligenceFindingName

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

IntelligenceFindingName(string, string, string)

public IntelligenceFindingName(string projectId, string locationId, string intelligenceFindingId)

Constructs a new instance of a IntelligenceFindingName class from the component parts of pattern projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

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.

intelligenceFindingId string

The IntelligenceFinding ID. Must not be null or empty.

Properties

IntelligenceFindingId

public string IntelligenceFindingId { get; }

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

The IntelligenceFindingName.ResourceNameType of the contained resource name.

Property Value
Type Description
IntelligenceFindingNameResourceNameType

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

Formats the IDs into the string representation of this IntelligenceFindingName with pattern projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}.

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.

intelligenceFindingId string

The IntelligenceFinding ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this IntelligenceFindingName with pattern projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}.

FormatProjectLocationIntelligenceFinding(string, string, string)

public static string FormatProjectLocationIntelligenceFinding(string projectId, string locationId, string intelligenceFindingId)

Formats the IDs into the string representation of this IntelligenceFindingName with pattern projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}.

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.

intelligenceFindingId string

The IntelligenceFinding ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this IntelligenceFindingName with pattern projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}.

FromProjectLocationIntelligenceFinding(string, string, string)

public static IntelligenceFindingName FromProjectLocationIntelligenceFinding(string projectId, string locationId, string intelligenceFindingId)

Creates a IntelligenceFindingName with the pattern projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}.

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.

intelligenceFindingId string

The IntelligenceFinding ID. Must not be null or empty.

Returns
Type Description
IntelligenceFindingName

A new instance of IntelligenceFindingName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static IntelligenceFindingName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a IntelligenceFindingName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
IntelligenceFindingName

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

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

Parameter
Name Description
intelligenceFindingName string

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

Returns
Type Description
IntelligenceFindingName

The parsed IntelligenceFindingName if successful.

Remarks

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

  • projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

Parse(string, bool)

public static IntelligenceFindingName Parse(string intelligenceFindingName, bool allowUnparsed)

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

Parameters
Name Description
intelligenceFindingName 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
IntelligenceFindingName

The parsed IntelligenceFindingName if successful.

Remarks

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

  • projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

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

public static bool TryParse(string intelligenceFindingName, out IntelligenceFindingName result)

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

Parameters
Name Description
intelligenceFindingName string

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

result IntelligenceFindingName

When this method returns, the parsed IntelligenceFindingName, 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}/intelligenceFindings/{intelligence_finding}

TryParse(string, bool, out IntelligenceFindingName)

public static bool TryParse(string intelligenceFindingName, bool allowUnparsed, out IntelligenceFindingName result)

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

Parameters
Name Description
intelligenceFindingName 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 IntelligenceFindingName

When this method returns, the parsed IntelligenceFindingName, 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}/intelligenceFindings/{intelligence_finding}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(IntelligenceFindingName, IntelligenceFindingName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a IntelligenceFindingName

The first resource name to compare, or null.

b IntelligenceFindingName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a IntelligenceFindingName

The first resource name to compare, or null.

b IntelligenceFindingName

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.