Class TriggerName (1.0.0-beta01)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class TriggerName : IResourceName, IEquatable<TriggerName>

Resource name for the Trigger resource.

Inheritance

System.Object > TriggerName

Implements

IResourceName, System.IEquatable<TriggerName>

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
NameDescription
projectIdSystem.String

The Project ID. Must not be null or empty.

locationIdSystem.String

The Location ID. Must not be null or empty.

triggerIdSystem.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
TypeDescription
System.Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
System.String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
System.String

TriggerId

public string TriggerId { get; }

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

Property Value
TypeDescription
System.String

Type

public TriggerName.ResourceNameType Type { get; }

The TriggerName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TriggerName.ResourceNameType

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

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

Parameters
NameDescription
projectIdSystem.String

The Project ID. Must not be null or empty.

locationIdSystem.String

The Location ID. Must not be null or empty.

triggerIdSystem.String

The Trigger ID. Must not be null or empty.

Returns
TypeDescription
System.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
NameDescription
projectIdSystem.String

The Project ID. Must not be null or empty.

locationIdSystem.String

The Location ID. Must not be null or empty.

triggerIdSystem.String

The Trigger ID. Must not be null or empty.

Returns
TypeDescription
System.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
NameDescription
projectIdSystem.String

The Project ID. Must not be null or empty.

locationIdSystem.String

The Location ID. Must not be null or empty.

triggerIdSystem.String

The Trigger ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TriggerName

A new instance of TriggerName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
System.Int32
Overrides
System.Object.GetHashCode()

Parse(String)

public static TriggerName Parse(string triggerName)

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

Parameter
NameDescription
triggerNameSystem.String

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

Returns
TypeDescription
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
NameDescription
triggerNameSystem.String

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

allowUnparsedSystem.Boolean

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns
TypeDescription
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
TypeDescription
System.String

The string representation of the resource name.

Overrides
System.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
NameDescription
triggerNameSystem.String

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

resultTriggerName

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

Returns
TypeDescription
System.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
NameDescription
triggerNameSystem.String

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

allowUnparsedSystem.Boolean

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

resultTriggerName

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

Returns
TypeDescription
System.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
NameDescription
aTriggerName
bTriggerName
Returns
TypeDescription
System.Boolean

Inequality(TriggerName, TriggerName)

public static bool operator !=(TriggerName a, TriggerName b)
Parameters
NameDescription
aTriggerName
bTriggerName
Returns
TypeDescription
System.Boolean