Chronicle v1 API - Class FindingsRefinementName (1.0.0-beta07) 

public sealed class FindingsRefinementName : IResourceName, IEquatable<FindingsRefinementName>

Reference documentation and code samples for the Chronicle v1 API class FindingsRefinementName.

Resource name for the FindingsRefinement resource.

Inheritance

object > FindingsRefinementName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

FindingsRefinementName(string, string, string, string)

public FindingsRefinementName(string projectId, string locationId, string instanceId, string findingsRefinementId)

Constructs a new instance of a FindingsRefinementName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}

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

The FindingsRefinement ID. Must not be null or empty.

Properties

FindingsRefinementId

public string FindingsRefinementId { get; }

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

The FindingsRefinementName.ResourceNameType of the contained resource name.

Property Value
Type Description
FindingsRefinementNameResourceNameType

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

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

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

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

The string representation of this FindingsRefinementName with pattern projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement} .

FormatProjectLocationInstanceFindingsRefinement(string, string, string, string)

public static string FormatProjectLocationInstanceFindingsRefinement(string projectId, string locationId, string instanceId, string findingsRefinementId)

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

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

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

The string representation of this FindingsRefinementName with pattern projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement} .

FromProjectLocationInstanceFindingsRefinement(string, string, string, string)

public static FindingsRefinementName FromProjectLocationInstanceFindingsRefinement(string projectId, string locationId, string instanceId, string findingsRefinementId)

Creates a FindingsRefinementName with the pattern projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement} .

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

The FindingsRefinement ID. Must not be null or empty.
Returns
Type Description
FindingsRefinementName

A new instance of FindingsRefinementName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FindingsRefinementName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FindingsRefinementName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
findingsRefinementName string

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

The parsed FindingsRefinementName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}

Parse(string, bool)

public static FindingsRefinementName Parse(string findingsRefinementName, bool allowUnparsed)

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

Parameters
Name Description
findingsRefinementName 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
FindingsRefinementName

The parsed FindingsRefinementName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}

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

public static bool TryParse(string findingsRefinementName, out FindingsRefinementName result)

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

Parameters
Name Description
findingsRefinementName string

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

When this method returns, the parsed FindingsRefinementName, 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}/findingsRefinements/{findings_refinement}

TryParse(string, bool, out FindingsRefinementName)

public static bool TryParse(string findingsRefinementName, bool allowUnparsed, out FindingsRefinementName result)

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

Parameters
Name Description
findingsRefinementName 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 FindingsRefinementName

When this method returns, the parsed FindingsRefinementName, 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}/findingsRefinements/{findings_refinement}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FindingsRefinementName, FindingsRefinementName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FindingsRefinementName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FindingsRefinementName

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

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.