Network Security v1beta1 API - Class ServerTlsPolicyName (2.0.0-beta03)

public sealed class ServerTlsPolicyName : IResourceName, IEquatable<ServerTlsPolicyName>

Reference documentation and code samples for the Network Security v1beta1 API class ServerTlsPolicyName.

Resource name for the ServerTlsPolicy resource.

Inheritance

Object > ServerTlsPolicyName

Namespace

Google.Cloud.NetworkSecurity.V1Beta1

Assembly

Google.Cloud.NetworkSecurity.V1Beta1.dll

Constructors

ServerTlsPolicyName(String, String, String)

public ServerTlsPolicyName(string projectId, string locationId, string serverTlsPolicyId)

Constructs a new instance of a ServerTlsPolicyName class from the component parts of pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

serverTlsPolicyIdString

The ServerTlsPolicy 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
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

ServerTlsPolicyId

public string ServerTlsPolicyId { get; }

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

Property Value
TypeDescription
String

Type

public ServerTlsPolicyName.ResourceNameType Type { get; }

The ServerTlsPolicyName.ResourceNameType of the contained resource name.

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

Formats the IDs into the string representation of this ServerTlsPolicyName with pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

serverTlsPolicyIdString

The ServerTlsPolicy ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ServerTlsPolicyName with pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}.

FormatProjectLocationServerTlsPolicy(String, String, String)

public static string FormatProjectLocationServerTlsPolicy(string projectId, string locationId, string serverTlsPolicyId)

Formats the IDs into the string representation of this ServerTlsPolicyName with pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

serverTlsPolicyIdString

The ServerTlsPolicy ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ServerTlsPolicyName with pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}.

FromProjectLocationServerTlsPolicy(String, String, String)

public static ServerTlsPolicyName FromProjectLocationServerTlsPolicy(string projectId, string locationId, string serverTlsPolicyId)

Creates a ServerTlsPolicyName with the pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

serverTlsPolicyIdString

The ServerTlsPolicy ID. Must not be null or empty.

Returns
TypeDescription
ServerTlsPolicyName

A new instance of ServerTlsPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServerTlsPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServerTlsPolicyName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ServerTlsPolicyName

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

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

Parameter
NameDescription
serverTlsPolicyNameString

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

Returns
TypeDescription
ServerTlsPolicyName

The parsed ServerTlsPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}

Parse(String, Boolean)

public static ServerTlsPolicyName Parse(string serverTlsPolicyName, bool allowUnparsed)

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

Parameters
NameDescription
serverTlsPolicyNameString

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
ServerTlsPolicyName

The parsed ServerTlsPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}
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 ServerTlsPolicyName)

public static bool TryParse(string serverTlsPolicyName, out ServerTlsPolicyName result)

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

Parameters
NameDescription
serverTlsPolicyNameString

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

resultServerTlsPolicyName

When this method returns, the parsed ServerTlsPolicyName, 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}/serverTlsPolicies/{server_tls_policy}

TryParse(String, Boolean, out ServerTlsPolicyName)

public static bool TryParse(string serverTlsPolicyName, bool allowUnparsed, out ServerTlsPolicyName result)

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

Parameters
NameDescription
serverTlsPolicyNameString

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.

resultServerTlsPolicyName

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

Operators

Equality(ServerTlsPolicyName, ServerTlsPolicyName)

public static bool operator ==(ServerTlsPolicyName a, ServerTlsPolicyName b)
Parameters
NameDescription
aServerTlsPolicyName
bServerTlsPolicyName
Returns
TypeDescription
Boolean

Inequality(ServerTlsPolicyName, ServerTlsPolicyName)

public static bool operator !=(ServerTlsPolicyName a, ServerTlsPolicyName b)
Parameters
NameDescription
aServerTlsPolicyName
bServerTlsPolicyName
Returns
TypeDescription
Boolean