Cloud Controls Partner v1 API - Class PartnerName (1.1.0) 

public sealed class PartnerName : IResourceName, IEquatable<PartnerName>

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

Resource name for the Partner resource.

Inheritance

object > PartnerName

Namespace

Google.Cloud.CloudControlsPartner.V1

Assembly

Google.Cloud.CloudControlsPartner.V1.dll

Constructors

PartnerName(string, string)

public PartnerName(string organizationId, string locationId)

Constructs a new instance of a PartnerName class from the component parts of pattern organizations/{organization}/locations/{location}/partner

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.

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

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

The PartnerName.ResourceNameType of the contained resource name.

Property Value
Type Description
PartnerNameResourceNameType

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)

public static string Format(string organizationId, string locationId)

Formats the IDs into the string representation of this PartnerName with pattern organizations/{organization}/locations/{location}/partner.

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.
Returns
Type Description
string

The string representation of this PartnerName with pattern organizations/{organization}/locations/{location}/partner.

FormatOrganizationLocation(string, string)

public static string FormatOrganizationLocation(string organizationId, string locationId)

Formats the IDs into the string representation of this PartnerName with pattern organizations/{organization}/locations/{location}/partner.

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.
Returns
Type Description
string

The string representation of this PartnerName with pattern organizations/{organization}/locations/{location}/partner.

FromOrganizationLocation(string, string)

public static PartnerName FromOrganizationLocation(string organizationId, string locationId)

Creates a PartnerName with the pattern organizations/{organization}/locations/{location}/partner.

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.
Returns
Type Description
PartnerName

A new instance of PartnerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PartnerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PartnerName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
partnerName string

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

The parsed PartnerName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/partner

Parse(string, bool)

public static PartnerName Parse(string partnerName, bool allowUnparsed)

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

Parameters
Name Description
partnerName 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
PartnerName

The parsed PartnerName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/partner
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 PartnerName)

public static bool TryParse(string partnerName, out PartnerName result)

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

Parameters
Name Description
partnerName string

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

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

TryParse(string, bool, out PartnerName)

public static bool TryParse(string partnerName, bool allowUnparsed, out PartnerName result)

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

Parameters
Name Description
partnerName 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 PartnerName

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

Operators

operator ==(PartnerName, PartnerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PartnerName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PartnerName

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

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.