Dialogflow v3 API - Class WebhookName (2.18.0) 

public sealed class WebhookName : IResourceName, IEquatable<WebhookName>

Reference documentation and code samples for the Dialogflow v3 API class WebhookName.

Resource name for the Webhook resource.

Inheritance

object > WebhookName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

WebhookName(string, string, string, string)

public WebhookName(string projectId, string locationId, string agentId, string webhookId)

Constructs a new instance of a WebhookName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}

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.
agentId string

The Agent ID. Must not be null or empty.
webhookId string

The Webhook ID. Must not be null or empty.

Properties

AgentId

public string AgentId { get; }

The Agent 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 WebhookName.ResourceNameType Type { get; }

The WebhookName.ResourceNameType of the contained resource name.

Property Value
Type Description
WebhookNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

WebhookId

public string WebhookId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string agentId, string webhookId)

Formats the IDs into the string representation of this WebhookName with pattern projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}.

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.
agentId string

The Agent ID. Must not be null or empty.
webhookId string

The Webhook ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this WebhookName with pattern projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}.

FormatProjectLocationAgentWebhook(string, string, string, string)

public static string FormatProjectLocationAgentWebhook(string projectId, string locationId, string agentId, string webhookId)

Formats the IDs into the string representation of this WebhookName with pattern projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}.

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.
agentId string

The Agent ID. Must not be null or empty.
webhookId string

The Webhook ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this WebhookName with pattern projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}.

FromProjectLocationAgentWebhook(string, string, string, string)

public static WebhookName FromProjectLocationAgentWebhook(string projectId, string locationId, string agentId, string webhookId)

Creates a WebhookName with the pattern projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}.

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.
agentId string

The Agent ID. Must not be null or empty.
webhookId string

The Webhook ID. Must not be null or empty.
Returns
Type Description
WebhookName

A new instance of WebhookName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WebhookName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WebhookName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of WebhookName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static WebhookName Parse(string webhookName)

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

Parameter
Name Description
webhookName string

The resource name in string form. Must not be null.
Returns
Type Description
WebhookName

The parsed WebhookName if successful.
Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}

Parse(string, bool)

public static WebhookName Parse(string webhookName, bool allowUnparsed)

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

Parameters
Name Description
webhookName 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
WebhookName

The parsed WebhookName if successful.
Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}
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 WebhookName)

public static bool TryParse(string webhookName, out WebhookName result)

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

Parameters
Name Description
webhookName string

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

When this method returns, the parsed WebhookName, 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}/agents/{agent}/webhooks/{webhook}

TryParse(string, bool, out WebhookName)

public static bool TryParse(string webhookName, bool allowUnparsed, out WebhookName result)

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

Parameters
Name Description
webhookName 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 WebhookName

When this method returns, the parsed WebhookName, 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}/agents/{agent}/webhooks/{webhook}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(WebhookName, WebhookName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a WebhookName

The first resource name to compare, or null.
b WebhookName

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 !=(WebhookName, WebhookName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a WebhookName

The first resource name to compare, or null.
b WebhookName

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.