BeyondCorp Client Connector Services v1 API - Class ClientConnectorServiceName (1.1.0) 

public sealed class ClientConnectorServiceName : IResourceName, IEquatable<ClientConnectorServiceName>

Reference documentation and code samples for the BeyondCorp Client Connector Services v1 API class ClientConnectorServiceName.

Resource name for the ClientConnectorService resource.

Inheritance

object > ClientConnectorServiceName

Namespace

Google.Cloud.BeyondCorp.ClientConnectorServices.V1

Assembly

Google.Cloud.BeyondCorp.ClientConnectorServices.V1.dll

Constructors

ClientConnectorServiceName(string, string, string)

public ClientConnectorServiceName(string projectId, string locationId, string clientConnectorServiceId)

Constructs a new instance of a ClientConnectorServiceName class from the component parts of pattern projects/{project}/locations/{location}/clientConnectorServices/{client_connector_service}

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

The ClientConnectorService ID. Must not be null or empty.

Properties

ClientConnectorServiceId

public string ClientConnectorServiceId { get; }

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

The ClientConnectorServiceName.ResourceNameType of the contained resource name.

Property Value
Type Description
ClientConnectorServiceNameResourceNameType

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

Formats the IDs into the string representation of this ClientConnectorServiceName with pattern projects/{project}/locations/{location}/clientConnectorServices/{client_connector_service}.

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

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

The string representation of this ClientConnectorServiceName with pattern projects/{project}/locations/{location}/clientConnectorServices/{client_connector_service}.

FormatProjectLocationClientConnectorService(string, string, string)

public static string FormatProjectLocationClientConnectorService(string projectId, string locationId, string clientConnectorServiceId)

Formats the IDs into the string representation of this ClientConnectorServiceName with pattern projects/{project}/locations/{location}/clientConnectorServices/{client_connector_service}.

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

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

The string representation of this ClientConnectorServiceName with pattern projects/{project}/locations/{location}/clientConnectorServices/{client_connector_service}.

FromProjectLocationClientConnectorService(string, string, string)

public static ClientConnectorServiceName FromProjectLocationClientConnectorService(string projectId, string locationId, string clientConnectorServiceId)

Creates a ClientConnectorServiceName with the pattern projects/{project}/locations/{location}/clientConnectorServices/{client_connector_service}.

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

The ClientConnectorService ID. Must not be null or empty.
Returns
Type Description
ClientConnectorServiceName

A new instance of ClientConnectorServiceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ClientConnectorServiceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ClientConnectorServiceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
clientConnectorServiceName string

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

The parsed ClientConnectorServiceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/clientConnectorServices/{client_connector_service}

Parse(string, bool)

public static ClientConnectorServiceName Parse(string clientConnectorServiceName, bool allowUnparsed)

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

Parameters
Name Description
clientConnectorServiceName 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
ClientConnectorServiceName

The parsed ClientConnectorServiceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/clientConnectorServices/{client_connector_service}
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 ClientConnectorServiceName)

public static bool TryParse(string clientConnectorServiceName, out ClientConnectorServiceName result)

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

Parameters
Name Description
clientConnectorServiceName string

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

When this method returns, the parsed ClientConnectorServiceName, 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}/clientConnectorServices/{client_connector_service}

TryParse(string, bool, out ClientConnectorServiceName)

public static bool TryParse(string clientConnectorServiceName, bool allowUnparsed, out ClientConnectorServiceName result)

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

Parameters
Name Description
clientConnectorServiceName 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 ClientConnectorServiceName

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

Operators

operator ==(ClientConnectorServiceName, ClientConnectorServiceName)

public static bool operator ==(ClientConnectorServiceName a, ClientConnectorServiceName b)
Parameters
Name Description
a ClientConnectorServiceName
b ClientConnectorServiceName
Returns
Type Description
bool

operator !=(ClientConnectorServiceName, ClientConnectorServiceName)

public static bool operator !=(ClientConnectorServiceName a, ClientConnectorServiceName b)
Parameters
Name Description
a ClientConnectorServiceName
b ClientConnectorServiceName
Returns
Type Description
bool