Cloud Controls Partner v1beta API - Class EkmConnectionsName (1.0.0-beta02) 

public sealed class EkmConnectionsName : IResourceName, IEquatable<EkmConnectionsName>

Reference documentation and code samples for the Cloud Controls Partner v1beta API class EkmConnectionsName.

Resource name for the EkmConnections resource.

Inheritance

object > EkmConnectionsName

Namespace

Google.Cloud.CloudControlsPartner.V1Beta

Assembly

Google.Cloud.CloudControlsPartner.V1Beta.dll

Constructors

EkmConnectionsName(string, string, string, string)

public EkmConnectionsName(string organizationId, string locationId, string customerId, string workloadId)

Constructs a new instance of a EkmConnectionsName class from the component parts of pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
customerId string

The Customer ID. Must not be null or empty.
workloadId string

The Workload ID. Must not be null or empty.

Properties

CustomerId

public string CustomerId { get; }

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

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

Type

public EkmConnectionsName.ResourceNameType Type { get; }

The EkmConnectionsName.ResourceNameType of the contained resource name.

Property Value
Type Description
EkmConnectionsNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

WorkloadId

public string WorkloadId { get; }

The Workload 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 organizationId, string locationId, string customerId, string workloadId)

Formats the IDs into the string representation of this EkmConnectionsName with pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections .

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
customerId string

The Customer ID. Must not be null or empty.
workloadId string

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

The string representation of this EkmConnectionsName with pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections .

FormatOrganizationLocationCustomerWorkload(string, string, string, string)

public static string FormatOrganizationLocationCustomerWorkload(string organizationId, string locationId, string customerId, string workloadId)

Formats the IDs into the string representation of this EkmConnectionsName with pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections .

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
customerId string

The Customer ID. Must not be null or empty.
workloadId string

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

The string representation of this EkmConnectionsName with pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections .

FromOrganizationLocationCustomerWorkload(string, string, string, string)

public static EkmConnectionsName FromOrganizationLocationCustomerWorkload(string organizationId, string locationId, string customerId, string workloadId)

Creates a EkmConnectionsName with the pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections .

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
customerId string

The Customer ID. Must not be null or empty.
workloadId string

The Workload ID. Must not be null or empty.
Returns
Type Description
EkmConnectionsName

A new instance of EkmConnectionsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EkmConnectionsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EkmConnectionsName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
ekmConnectionsName string

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

The parsed EkmConnectionsName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections

Parse(string, bool)

public static EkmConnectionsName Parse(string ekmConnectionsName, bool allowUnparsed)

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

Parameters
Name Description
ekmConnectionsName 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
EkmConnectionsName

The parsed EkmConnectionsName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
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 EkmConnectionsName)

public static bool TryParse(string ekmConnectionsName, out EkmConnectionsName result)

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

Parameters
Name Description
ekmConnectionsName string

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

When this method returns, the parsed EkmConnectionsName, 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:

  • organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections

TryParse(string, bool, out EkmConnectionsName)

public static bool TryParse(string ekmConnectionsName, bool allowUnparsed, out EkmConnectionsName result)

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

Parameters
Name Description
ekmConnectionsName 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 EkmConnectionsName

When this method returns, the parsed EkmConnectionsName, 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:

  • organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EkmConnectionsName, EkmConnectionsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EkmConnectionsName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EkmConnectionsName

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

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.