Integration Connectors v1 API - Class ProviderName (1.1.0)

public sealed class ProviderName : IResourceName, IEquatable<ProviderName>

Reference documentation and code samples for the Integration Connectors v1 API class ProviderName.

Resource name for the Provider resource.

Inheritance

object > ProviderName

Namespace

Google.Cloud.Connectors.V1

Assembly

Google.Cloud.Connectors.V1.dll

Constructors

ProviderName(string, string, string)

public ProviderName(string projectId, string locationId, string providerId)

Constructs a new instance of a ProviderName class from the component parts of pattern projects/{project}/locations/{location}/providers/{provider}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

providerIdstring

The Provider 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
bool

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

ProviderId

public string ProviderId { get; }

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

Property Value
TypeDescription
string

Type

public ProviderName.ResourceNameType Type { get; }

The ProviderName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ProviderNameResourceNameType

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

Formats the IDs into the string representation of this ProviderName with pattern projects/{project}/locations/{location}/providers/{provider}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

providerIdstring

The Provider ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ProviderName with pattern projects/{project}/locations/{location}/providers/{provider}.

FormatProjectLocationProvider(string, string, string)

public static string FormatProjectLocationProvider(string projectId, string locationId, string providerId)

Formats the IDs into the string representation of this ProviderName with pattern projects/{project}/locations/{location}/providers/{provider}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

providerIdstring

The Provider ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ProviderName with pattern projects/{project}/locations/{location}/providers/{provider}.

FromProjectLocationProvider(string, string, string)

public static ProviderName FromProjectLocationProvider(string projectId, string locationId, string providerId)

Creates a ProviderName with the pattern projects/{project}/locations/{location}/providers/{provider}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

providerIdstring

The Provider ID. Must not be null or empty.

Returns
TypeDescription
ProviderName

A new instance of ProviderName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProviderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProviderName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ProviderName

A new instance of ProviderName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ProviderName Parse(string providerName)

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

Parameter
NameDescription
providerNamestring

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

Returns
TypeDescription
ProviderName

The parsed ProviderName if successful.

Remarks

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

  • projects/{project}/locations/{location}/providers/{provider}

Parse(string, bool)

public static ProviderName Parse(string providerName, bool allowUnparsed)

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

Parameters
NameDescription
providerNamestring

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

allowUnparsedbool

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
ProviderName

The parsed ProviderName if successful.

Remarks

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

  • projects/{project}/locations/{location}/providers/{provider}
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 ProviderName)

public static bool TryParse(string providerName, out ProviderName result)

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

Parameters
NameDescription
providerNamestring

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

resultProviderName

When this method returns, the parsed ProviderName, or null if parsing failed.

Returns
TypeDescription
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}/providers/{provider}

TryParse(string, bool, out ProviderName)

public static bool TryParse(string providerName, bool allowUnparsed, out ProviderName result)

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

Parameters
NameDescription
providerNamestring

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

allowUnparsedbool

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.

resultProviderName

When this method returns, the parsed ProviderName, or null if parsing failed.

Returns
TypeDescription
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}/providers/{provider}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProviderName, ProviderName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aProviderName

The first resource name to compare, or null.

bProviderName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ProviderName, ProviderName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aProviderName

The first resource name to compare, or null.

bProviderName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.