Cloud Functions v2 API - Class TriggerName (1.1.0)

public sealed class TriggerName : IResourceName, IEquatable<TriggerName>

Reference documentation and code samples for the Cloud Functions v2 API class TriggerName.

Resource name for the Trigger resource.

Inheritance

Object > TriggerName

Implements

IResourceName, IEquatable<TriggerName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Functions.V2

Assembly

Google.Cloud.Functions.V2.dll

Constructors

TriggerName(String, String, String)

public TriggerName(string projectId, string locationId, string triggerId)

Constructs a new instance of a TriggerName class from the component parts of pattern projects/{project}/locations/{location}/triggers/{trigger}

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.
`triggerId`	`String` The `Trigger` 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`

TriggerId

public string TriggerId { get; }

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

Property Value
Type	Description
`String`

Type

public TriggerName.ResourceNameType Type { get; }

The TriggerName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TriggerName.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 triggerId)

Formats the IDs into the string representation of this TriggerName with pattern projects/{project}/locations/{location}/triggers/{trigger}.

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.
`triggerId`	`String` The `Trigger` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this TriggerName with pattern `projects/{project}/locations/{location}/triggers/{trigger}`.

FormatProjectLocationTrigger(String, String, String)

public static string FormatProjectLocationTrigger(string projectId, string locationId, string triggerId)

Formats the IDs into the string representation of this TriggerName with pattern projects/{project}/locations/{location}/triggers/{trigger}.

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.
`triggerId`	`String` The `Trigger` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this TriggerName with pattern `projects/{project}/locations/{location}/triggers/{trigger}`.

FromProjectLocationTrigger(String, String, String)

public static TriggerName FromProjectLocationTrigger(string projectId, string locationId, string triggerId)

Creates a TriggerName with the pattern projects/{project}/locations/{location}/triggers/{trigger}.

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.
`triggerId`	`String` The `Trigger` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static TriggerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TriggerName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static TriggerName Parse(string triggerName)

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

Parameter
Name	Description
`triggerName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`TriggerName`	The parsed TriggerName if successful.

Remarks

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

projects/{project}/locations/{location}/triggers/{trigger}

Parse(String, Boolean)

public static TriggerName Parse(string triggerName, bool allowUnparsed)

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

Parameters
Name	Description
`triggerName`	`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
`TriggerName`	The parsed TriggerName if successful.

Remarks

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

projects/{project}/locations/{location}/triggers/{trigger}

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

public static bool TryParse(string triggerName, out TriggerName result)

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

Parameters
Name	Description
`triggerName`	`String` The resource name in string form. Must not be `null`.
`result`	`TriggerName` When this method returns, the parsed TriggerName, 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}/triggers/{trigger}

TryParse(String, Boolean, out TriggerName)

public static bool TryParse(string triggerName, bool allowUnparsed, out TriggerName result)

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

Parameters
Name	Description
`triggerName`	`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`	`TriggerName` When this method returns, the parsed TriggerName, 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}/triggers/{trigger}

Or may be in any format if allowUnparsed is true.

Operators

Equality(TriggerName, TriggerName)

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

Parameters
Name	Description
`a`	`TriggerName`
`b`	`TriggerName`

Returns
Type	Description
`Boolean`

Inequality(TriggerName, TriggerName)

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

Parameters
Name	Description
`a`	`TriggerName`
`b`	`TriggerName`

Returns
Type	Description
`Boolean`