Network Security v1 API - Class UrlListName (1.0.0-beta01) 

public sealed class UrlListName : IResourceName, IEquatable<UrlListName>

Reference documentation and code samples for the Network Security v1 API class UrlListName.

Resource name for the UrlList resource.

Inheritance

object > UrlListName

Namespace

Google.Cloud.NetworkSecurity.V1

Assembly

Google.Cloud.NetworkSecurity.V1.dll

Constructors

UrlListName(string, string, string)

public UrlListName(string projectId, string locationId, string urlListId)

Constructs a new instance of a UrlListName class from the component parts of pattern projects/{project}/locations/{location}/urlLists/{url_list}

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

The UrlList ID. Must not be null or empty.

Properties

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

The UrlListName.ResourceNameType of the contained resource name.

Property Value
Type Description
UrlListNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

UrlListId

public string UrlListId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string urlListId)

Formats the IDs into the string representation of this UrlListName with pattern projects/{project}/locations/{location}/urlLists/{url_list}.

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

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

The string representation of this UrlListName with pattern projects/{project}/locations/{location}/urlLists/{url_list}.

FormatProjectLocationUrlList(string, string, string)

public static string FormatProjectLocationUrlList(string projectId, string locationId, string urlListId)

Formats the IDs into the string representation of this UrlListName with pattern projects/{project}/locations/{location}/urlLists/{url_list}.

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

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

The string representation of this UrlListName with pattern projects/{project}/locations/{location}/urlLists/{url_list}.

FromProjectLocationUrlList(string, string, string)

public static UrlListName FromProjectLocationUrlList(string projectId, string locationId, string urlListId)

Creates a UrlListName with the pattern projects/{project}/locations/{location}/urlLists/{url_list}.

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

The UrlList ID. Must not be null or empty.
Returns
Type Description
UrlListName

A new instance of UrlListName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static UrlListName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UrlListName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
urlListName string

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

The parsed UrlListName if successful.
Remarks

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

  • projects/{project}/locations/{location}/urlLists/{url_list}

Parse(string, bool)

public static UrlListName Parse(string urlListName, bool allowUnparsed)

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

Parameters
Name Description
urlListName 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
UrlListName

The parsed UrlListName if successful.
Remarks

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

  • projects/{project}/locations/{location}/urlLists/{url_list}

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

public static bool TryParse(string urlListName, out UrlListName result)

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

Parameters
Name Description
urlListName string

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

When this method returns, the parsed UrlListName, 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}/urlLists/{url_list}

TryParse(string, bool, out UrlListName)

public static bool TryParse(string urlListName, bool allowUnparsed, out UrlListName result)

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

Parameters
Name Description
urlListName 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 UrlListName

When this method returns, the parsed UrlListName, 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}/urlLists/{url_list}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(UrlListName, UrlListName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a UrlListName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a UrlListName

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

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.