Cloud Controls Partner v1 API - Class PartnerPermissionsName (1.0.0-beta02) 

public sealed class PartnerPermissionsName : IResourceName, IEquatable<PartnerPermissionsName>

Reference documentation and code samples for the Cloud Controls Partner v1 API class PartnerPermissionsName.

Resource name for the PartnerPermissions resource.

Inheritance

object > PartnerPermissionsName

Namespace

Google.Cloud.CloudControlsPartner.V1

Assembly

Google.Cloud.CloudControlsPartner.V1.dll

Constructors

PartnerPermissionsName(string, string, string, string)

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

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

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

The PartnerPermissionsName.ResourceNameType of the contained resource name.

Property Value
Type Description
PartnerPermissionsNameResourceNameType

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 PartnerPermissionsName with pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions .

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 PartnerPermissionsName with pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions .

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 PartnerPermissionsName with pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions .

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 PartnerPermissionsName with pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions .

FromOrganizationLocationCustomerWorkload(string, string, string, string)

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

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

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
PartnerPermissionsName

A new instance of PartnerPermissionsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PartnerPermissionsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PartnerPermissionsName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
partnerPermissionsName string

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

The parsed PartnerPermissionsName 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}/partnerPermissions

Parse(string, bool)

public static PartnerPermissionsName Parse(string partnerPermissionsName, bool allowUnparsed)

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

Parameters
Name Description
partnerPermissionsName 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
PartnerPermissionsName

The parsed PartnerPermissionsName 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}/partnerPermissions
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 PartnerPermissionsName)

public static bool TryParse(string partnerPermissionsName, out PartnerPermissionsName result)

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

Parameters
Name Description
partnerPermissionsName string

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

When this method returns, the parsed PartnerPermissionsName, 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}/partnerPermissions

TryParse(string, bool, out PartnerPermissionsName)

public static bool TryParse(string partnerPermissionsName, bool allowUnparsed, out PartnerPermissionsName result)

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

Parameters
Name Description
partnerPermissionsName 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 PartnerPermissionsName

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

Operators

operator ==(PartnerPermissionsName, PartnerPermissionsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PartnerPermissionsName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PartnerPermissionsName

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

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.