Cloud Functions v2beta API - Class TriggerName (1.0.0-beta04)

Version 1.0.0-beta04

• 1.0.0-beta07 (latest)
• 1.0.0-beta06

public sealed class TriggerName : IResourceName, IEquatable<TriggerName>

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

Resource name for the Trigger resource.

Inheritance

object > TriggerName

Implements

IResourceName, IEquatableTriggerName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Functions.V2Beta

Assembly

Google.Cloud.Functions.V2Beta.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
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

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
TriggerNameResourceNameType

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
int

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, bool)

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	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
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
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}/triggers/{trigger}

TryParse(string, bool, 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	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	TriggerName When this method returns, the parsed TriggerName, 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}/triggers/{trigger}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TriggerName, TriggerName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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