Eventarc v1 API - Class IntegrationName (2.9.0)

Version latest

• 2.9.0 (latest)
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class IntegrationName : IResourceName, IEquatable<IntegrationName>

Reference documentation and code samples for the Eventarc v1 API class IntegrationName.

Resource name for the Integration resource.

Inheritance

object > IntegrationName

Implements

IResourceName, IEquatableIntegrationName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Eventarc.V1

Assembly

Google.Cloud.Eventarc.V1.dll

Constructors

IntegrationName(string, string, string)

public IntegrationName(string projectId, string locationId, string integrationId)

Constructs a new instance of a IntegrationName class from the component parts of pattern projects/{project}/locations/{location}/integrations/{integration}

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.
integrationId	string The Integration ID. Must not be null or empty.

Properties

IntegrationId

public string IntegrationId { get; }

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

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

Type

public IntegrationName.ResourceNameType Type { get; }

The IntegrationName.ResourceNameType of the contained resource name.

Property Value
Type	Description
IntegrationNameResourceNameType

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

Formats the IDs into the string representation of this IntegrationName with pattern projects/{project}/locations/{location}/integrations/{integration}.

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.
integrationId	string The Integration ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this IntegrationName with pattern projects/{project}/locations/{location}/integrations/{integration}.

FormatProjectLocationIntegration(string, string, string)

public static string FormatProjectLocationIntegration(string projectId, string locationId, string integrationId)

Formats the IDs into the string representation of this IntegrationName with pattern projects/{project}/locations/{location}/integrations/{integration}.

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.
integrationId	string The Integration ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this IntegrationName with pattern projects/{project}/locations/{location}/integrations/{integration}.

FromProjectLocationIntegration(string, string, string)

public static IntegrationName FromProjectLocationIntegration(string projectId, string locationId, string integrationId)

Creates a IntegrationName with the pattern projects/{project}/locations/{location}/integrations/{integration}.

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.
integrationId	string The Integration ID. Must not be null or empty.

Returns
Type	Description
IntegrationName	A new instance of IntegrationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static IntegrationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a IntegrationName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
IntegrationName	A new instance of IntegrationName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static IntegrationName Parse(string integrationName)

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

Parameter
Name	Description
integrationName	string The resource name in string form. Must not be null.

Returns
Type	Description
IntegrationName	The parsed IntegrationName if successful.

Remarks

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

• projects/{project}/locations/{location}/integrations/{integration}

Parse(string, bool)

public static IntegrationName Parse(string integrationName, bool allowUnparsed)

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

Parameters
Name	Description
integrationName	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
IntegrationName	The parsed IntegrationName if successful.

Remarks

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

• projects/{project}/locations/{location}/integrations/{integration}

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

object.ToString()

TryParse(string, out IntegrationName)

public static bool TryParse(string integrationName, out IntegrationName result)

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

Parameters
Name	Description
integrationName	string The resource name in string form. Must not be null.
result	IntegrationName When this method returns, the parsed IntegrationName, 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:

• projects/{project}/locations/{location}/integrations/{integration}

TryParse(string, bool, out IntegrationName)

public static bool TryParse(string integrationName, bool allowUnparsed, out IntegrationName result)

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

Parameters
Name	Description
integrationName	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	IntegrationName When this method returns, the parsed IntegrationName, 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:

• projects/{project}/locations/{location}/integrations/{integration}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(IntegrationName, IntegrationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	IntegrationName The first resource name to compare, or null.
b	IntegrationName 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 !=(IntegrationName, IntegrationName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	IntegrationName The first resource name to compare, or null.
b	IntegrationName 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.