Class ProviderName (1.3.0) 

public sealed class ProviderName : IResourceName, IEquatable<ProviderName>

Resource name for the Provider resource.

Inheritance

Object > ProviderName

Namespace

Google.Cloud.Eventarc.V1

Assembly

Google.Cloud.Eventarc.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
Name Description
projectId String

The Project ID. Must not be null or empty.
locationId String

The Location ID. Must not be null or empty.
providerId String

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
Type Description
Boolean

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

ProviderId

public string ProviderId { get; }

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

Property Value
Type Description
String

Type

public ProviderName.ResourceNameType Type { get; }

The ProviderName.ResourceNameType of the contained resource name.

Property Value
Type Description
ProviderName.ResourceNameType

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

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

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.
providerId String

The Provider ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId String

The Project ID. Must not be null or empty.
locationId String

The Location ID. Must not be null or empty.
providerId String

The Provider ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId String

The Project ID. Must not be null or empty.
locationId String

The Location ID. Must not be null or empty.
providerId String

The Provider ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of ProviderName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static ProviderName Parse(string providerName)

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

Parameter
Name Description
providerName String

The resource name in string form. Must not be null.
Returns
Type Description
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, Boolean)

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
Name Description
providerName String

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

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
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
Type Description
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
Name Description
providerName String

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

When this method returns, the parsed ProviderName, or null if parsing failed.
Returns
Type Description
Boolean

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, Boolean, 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
Name Description
providerName String

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

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 ProviderName

When this method returns, the parsed ProviderName, or null if parsing failed.
Returns
Type Description
Boolean

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

Equality(ProviderName, ProviderName)

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

Inequality(ProviderName, ProviderName)

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