Chronicle v1 API - Class WatchlistName (1.0.0-beta02) 

public sealed class WatchlistName : IResourceName, IEquatable<WatchlistName>

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

Resource name for the Watchlist resource.

Inheritance

object > WatchlistName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

WatchlistName(string, string, string, string)

public WatchlistName(string projectId, string locationId, string instanceId, string watchlistId)

Constructs a new instance of a WatchlistName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

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

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

The WatchlistName.ResourceNameType of the contained resource name.

Property Value
Type Description
WatchlistNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

WatchlistId

public string WatchlistId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string instanceId, string watchlistId)

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

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

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

The string representation of this WatchlistName with pattern projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}.

FormatProjectLocationInstanceWatchlist(string, string, string, string)

public static string FormatProjectLocationInstanceWatchlist(string projectId, string locationId, string instanceId, string watchlistId)

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

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

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

The string representation of this WatchlistName with pattern projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}.

FromProjectLocationInstanceWatchlist(string, string, string, string)

public static WatchlistName FromProjectLocationInstanceWatchlist(string projectId, string locationId, string instanceId, string watchlistId)

Creates a WatchlistName with the pattern projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}.

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

The Watchlist ID. Must not be null or empty.
Returns
Type Description
WatchlistName

A new instance of WatchlistName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WatchlistName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WatchlistName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
watchlistName string

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

The parsed WatchlistName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

Parse(string, bool)

public static WatchlistName Parse(string watchlistName, bool allowUnparsed)

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

Parameters
Name Description
watchlistName 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
WatchlistName

The parsed WatchlistName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}
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 WatchlistName)

public static bool TryParse(string watchlistName, out WatchlistName result)

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

Parameters
Name Description
watchlistName string

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

When this method returns, the parsed WatchlistName, 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}/watchlists/{watchlist}

TryParse(string, bool, out WatchlistName)

public static bool TryParse(string watchlistName, bool allowUnparsed, out WatchlistName result)

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

Parameters
Name Description
watchlistName 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 WatchlistName

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

Operators

operator ==(WatchlistName, WatchlistName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a WatchlistName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a WatchlistName

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

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.