cx

package
Version: v1.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 20, 2022 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Overview

Package cx is an auto-generated package for the Dialogflow API.

Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).

Example usage

To get started with this package, create a client.

ctx := context.Background()
c, err := cx.NewPagesClient(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
c, err := cx.NewPagesClient(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

req := &cxpb.ListPagesRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListPagesRequest.
}
it := c.ListPages(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

Types

type AgentIterator

type AgentIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.Agent, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AgentIterator manages a stream of *cxpb.Agent.

func (*AgentIterator) Next

func (it *AgentIterator) Next() (*cxpb.Agent, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*AgentIterator) PageInfo

func (it *AgentIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type AgentsCallOptions

type AgentsCallOptions struct {
	ListAgents               []gax.CallOption
	GetAgent                 []gax.CallOption
	CreateAgent              []gax.CallOption
	UpdateAgent              []gax.CallOption
	DeleteAgent              []gax.CallOption
	ExportAgent              []gax.CallOption
	RestoreAgent             []gax.CallOption
	ValidateAgent            []gax.CallOption
	GetAgentValidationResult []gax.CallOption
}

AgentsCallOptions contains the retry settings for each method of AgentsClient.

type AgentsClient

type AgentsClient struct {

	// The call options for this service.
	CallOptions *AgentsCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

AgentsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Agents.

func NewAgentsClient

func NewAgentsClient(ctx context.Context, opts ...option.ClientOption) (*AgentsClient, error)

NewAgentsClient creates a new agents client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Agents.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*AgentsClient) Close

func (c *AgentsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*AgentsClient) Connection

func (c *AgentsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*AgentsClient) CreateAgent

func (c *AgentsClient) CreateAgent(ctx context.Context, req *cxpb.CreateAgentRequest, opts ...gax.CallOption) (*cxpb.Agent, error)

CreateAgent creates an agent in the specified location.

Note: You should always train flows prior to sending them queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateAgentRequest.
	}
	resp, err := c.CreateAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*AgentsClient) DeleteAgent

func (c *AgentsClient) DeleteAgent(ctx context.Context, req *cxpb.DeleteAgentRequest, opts ...gax.CallOption) error

DeleteAgent deletes the specified agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteAgentRequest.
	}
	err = c.DeleteAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*AgentsClient) ExportAgent

ExportAgent exports the specified agent to a binary file.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: An empty Struct
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: ExportAgentResponse
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ExportAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ExportAgentRequest.
	}
	op, err := c.ExportAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*AgentsClient) ExportAgentOperation

func (c *AgentsClient) ExportAgentOperation(name string) *ExportAgentOperation

ExportAgentOperation returns a new ExportAgentOperation from a given name. The name must be that of a previously created ExportAgentOperation, possibly from a different process.

func (*AgentsClient) GetAgent

func (c *AgentsClient) GetAgent(ctx context.Context, req *cxpb.GetAgentRequest, opts ...gax.CallOption) (*cxpb.Agent, error)

GetAgent retrieves the specified agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetAgentRequest.
	}
	resp, err := c.GetAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*AgentsClient) GetAgentValidationResult

func (c *AgentsClient) GetAgentValidationResult(ctx context.Context, req *cxpb.GetAgentValidationResultRequest, opts ...gax.CallOption) (*cxpb.AgentValidationResult, error)

GetAgentValidationResult gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetAgentValidationResultRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetAgentValidationResultRequest.
	}
	resp, err := c.GetAgentValidationResult(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*AgentsClient) ListAgents

func (c *AgentsClient) ListAgents(ctx context.Context, req *cxpb.ListAgentsRequest, opts ...gax.CallOption) *AgentIterator

ListAgents returns the list of all agents in the specified location.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListAgentsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListAgentsRequest.
	}
	it := c.ListAgents(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*AgentsClient) RestoreAgent

RestoreAgent restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: An empty Struct
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: An Empty
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

Note: You should always train flows prior to sending them queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.RestoreAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#RestoreAgentRequest.
	}
	op, err := c.RestoreAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*AgentsClient) RestoreAgentOperation

func (c *AgentsClient) RestoreAgentOperation(name string) *RestoreAgentOperation

RestoreAgentOperation returns a new RestoreAgentOperation from a given name. The name must be that of a previously created RestoreAgentOperation, possibly from a different process.

func (*AgentsClient) UpdateAgent

func (c *AgentsClient) UpdateAgent(ctx context.Context, req *cxpb.UpdateAgentRequest, opts ...gax.CallOption) (*cxpb.Agent, error)

UpdateAgent updates the specified agent.

Note: You should always train flows prior to sending them queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateAgentRequest.
	}
	resp, err := c.UpdateAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*AgentsClient) ValidateAgent

ValidateAgent validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ValidateAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ValidateAgentRequest.
	}
	resp, err := c.ValidateAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type BatchRunTestCasesOperation

type BatchRunTestCasesOperation struct {
	// contains filtered or unexported fields
}

BatchRunTestCasesOperation manages a long-running operation from BatchRunTestCases.

func (*BatchRunTestCasesOperation) Done

func (op *BatchRunTestCasesOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*BatchRunTestCasesOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*BatchRunTestCasesOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*BatchRunTestCasesOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*BatchRunTestCasesOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type ChangelogIterator added in v1.2.0

type ChangelogIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.Changelog, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ChangelogIterator manages a stream of *cxpb.Changelog.

func (*ChangelogIterator) Next added in v1.2.0

func (it *ChangelogIterator) Next() (*cxpb.Changelog, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*ChangelogIterator) PageInfo added in v1.2.0

func (it *ChangelogIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type ChangelogsCallOptions added in v1.2.0

type ChangelogsCallOptions struct {
	ListChangelogs []gax.CallOption
	GetChangelog   []gax.CallOption
}

ChangelogsCallOptions contains the retry settings for each method of ChangelogsClient.

type ChangelogsClient added in v1.2.0

type ChangelogsClient struct {

	// The call options for this service.
	CallOptions *ChangelogsCallOptions
	// contains filtered or unexported fields
}

ChangelogsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Changelogs.

func NewChangelogsClient added in v1.2.0

func NewChangelogsClient(ctx context.Context, opts ...option.ClientOption) (*ChangelogsClient, error)

NewChangelogsClient creates a new changelogs client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Changelogs.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewChangelogsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*ChangelogsClient) Close added in v1.2.0

func (c *ChangelogsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*ChangelogsClient) Connection added in v1.2.0

func (c *ChangelogsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*ChangelogsClient) GetChangelog added in v1.2.0

func (c *ChangelogsClient) GetChangelog(ctx context.Context, req *cxpb.GetChangelogRequest, opts ...gax.CallOption) (*cxpb.Changelog, error)

GetChangelog retrieves the specified Changelog.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewChangelogsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetChangelogRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetChangelogRequest.
	}
	resp, err := c.GetChangelog(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ChangelogsClient) ListChangelogs added in v1.2.0

ListChangelogs returns the list of Changelogs.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewChangelogsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListChangelogsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListChangelogsRequest.
	}
	it := c.ListChangelogs(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

type ContinuousTestResultIterator

type ContinuousTestResultIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.ContinuousTestResult, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ContinuousTestResultIterator manages a stream of *cxpb.ContinuousTestResult.

func (*ContinuousTestResultIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*ContinuousTestResultIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type CreateEnvironmentOperation

type CreateEnvironmentOperation struct {
	// contains filtered or unexported fields
}

CreateEnvironmentOperation manages a long-running operation from CreateEnvironment.

func (*CreateEnvironmentOperation) Done

func (op *CreateEnvironmentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateEnvironmentOperation) Metadata

func (op *CreateEnvironmentOperation) Metadata() (*structpb.Struct, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateEnvironmentOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateEnvironmentOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateEnvironmentOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type CreateVersionOperation

type CreateVersionOperation struct {
	// contains filtered or unexported fields
}

CreateVersionOperation manages a long-running operation from CreateVersion.

func (*CreateVersionOperation) Done

func (op *CreateVersionOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateVersionOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateVersionOperation) Name

func (op *CreateVersionOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateVersionOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateVersionOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type DeployFlowOperation added in v1.1.0

type DeployFlowOperation struct {
	// contains filtered or unexported fields
}

DeployFlowOperation manages a long-running operation from DeployFlow.

func (*DeployFlowOperation) Done added in v1.1.0

func (op *DeployFlowOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeployFlowOperation) Metadata added in v1.1.0

func (op *DeployFlowOperation) Metadata() (*cxpb.DeployFlowMetadata, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeployFlowOperation) Name added in v1.1.0

func (op *DeployFlowOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeployFlowOperation) Poll added in v1.1.0

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeployFlowOperation) Wait added in v1.1.0

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type DeploymentIterator added in v1.1.0

type DeploymentIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.Deployment, nextPageToken string, err error)
	// contains filtered or unexported fields
}

DeploymentIterator manages a stream of *cxpb.Deployment.

func (*DeploymentIterator) Next added in v1.1.0

func (it *DeploymentIterator) Next() (*cxpb.Deployment, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*DeploymentIterator) PageInfo added in v1.1.0

func (it *DeploymentIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type DeploymentsCallOptions added in v1.1.0

type DeploymentsCallOptions struct {
	ListDeployments []gax.CallOption
	GetDeployment   []gax.CallOption
}

DeploymentsCallOptions contains the retry settings for each method of DeploymentsClient.

type DeploymentsClient added in v1.1.0

type DeploymentsClient struct {

	// The call options for this service.
	CallOptions *DeploymentsCallOptions
	// contains filtered or unexported fields
}

DeploymentsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Deployments.

func NewDeploymentsClient added in v1.1.0

func NewDeploymentsClient(ctx context.Context, opts ...option.ClientOption) (*DeploymentsClient, error)

NewDeploymentsClient creates a new deployments client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Deployments.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewDeploymentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*DeploymentsClient) Close added in v1.1.0

func (c *DeploymentsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*DeploymentsClient) Connection added in v1.1.0

func (c *DeploymentsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*DeploymentsClient) GetDeployment added in v1.1.0

func (c *DeploymentsClient) GetDeployment(ctx context.Context, req *cxpb.GetDeploymentRequest, opts ...gax.CallOption) (*cxpb.Deployment, error)

GetDeployment retrieves the specified Deployment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewDeploymentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetDeploymentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetDeploymentRequest.
	}
	resp, err := c.GetDeployment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*DeploymentsClient) ListDeployments added in v1.1.0

ListDeployments returns the list of all deployments in the specified Environment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewDeploymentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListDeploymentsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListDeploymentsRequest.
	}
	it := c.ListDeployments(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

type EntityTypeIterator

type EntityTypeIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.EntityType, nextPageToken string, err error)
	// contains filtered or unexported fields
}

EntityTypeIterator manages a stream of *cxpb.EntityType.

func (*EntityTypeIterator) Next

func (it *EntityTypeIterator) Next() (*cxpb.EntityType, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*EntityTypeIterator) PageInfo

func (it *EntityTypeIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type EntityTypesCallOptions

type EntityTypesCallOptions struct {
	ListEntityTypes  []gax.CallOption
	GetEntityType    []gax.CallOption
	CreateEntityType []gax.CallOption
	UpdateEntityType []gax.CallOption
	DeleteEntityType []gax.CallOption
}

EntityTypesCallOptions contains the retry settings for each method of EntityTypesClient.

type EntityTypesClient

type EntityTypesClient struct {

	// The call options for this service.
	CallOptions *EntityTypesCallOptions
	// contains filtered or unexported fields
}

EntityTypesClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing EntityTypes.

func NewEntityTypesClient

func NewEntityTypesClient(ctx context.Context, opts ...option.ClientOption) (*EntityTypesClient, error)

NewEntityTypesClient creates a new entity types client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing EntityTypes.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*EntityTypesClient) Close

func (c *EntityTypesClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*EntityTypesClient) Connection

func (c *EntityTypesClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*EntityTypesClient) CreateEntityType

func (c *EntityTypesClient) CreateEntityType(ctx context.Context, req *cxpb.CreateEntityTypeRequest, opts ...gax.CallOption) (*cxpb.EntityType, error)

CreateEntityType creates an entity type in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateEntityTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateEntityTypeRequest.
	}
	resp, err := c.CreateEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EntityTypesClient) DeleteEntityType

func (c *EntityTypesClient) DeleteEntityType(ctx context.Context, req *cxpb.DeleteEntityTypeRequest, opts ...gax.CallOption) error

DeleteEntityType deletes the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteEntityTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteEntityTypeRequest.
	}
	err = c.DeleteEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*EntityTypesClient) GetEntityType

func (c *EntityTypesClient) GetEntityType(ctx context.Context, req *cxpb.GetEntityTypeRequest, opts ...gax.CallOption) (*cxpb.EntityType, error)

GetEntityType retrieves the specified entity type.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetEntityTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetEntityTypeRequest.
	}
	resp, err := c.GetEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EntityTypesClient) ListEntityTypes

ListEntityTypes returns the list of all entity types in the specified agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListEntityTypesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListEntityTypesRequest.
	}
	it := c.ListEntityTypes(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*EntityTypesClient) UpdateEntityType

func (c *EntityTypesClient) UpdateEntityType(ctx context.Context, req *cxpb.UpdateEntityTypeRequest, opts ...gax.CallOption) (*cxpb.EntityType, error)

UpdateEntityType updates the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateEntityTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateEntityTypeRequest.
	}
	resp, err := c.UpdateEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type EnvironmentIterator

type EnvironmentIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.Environment, nextPageToken string, err error)
	// contains filtered or unexported fields
}

EnvironmentIterator manages a stream of *cxpb.Environment.

func (*EnvironmentIterator) Next

func (it *EnvironmentIterator) Next() (*cxpb.Environment, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*EnvironmentIterator) PageInfo

func (it *EnvironmentIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type EnvironmentsCallOptions

type EnvironmentsCallOptions struct {
	ListEnvironments          []gax.CallOption
	GetEnvironment            []gax.CallOption
	CreateEnvironment         []gax.CallOption
	UpdateEnvironment         []gax.CallOption
	DeleteEnvironment         []gax.CallOption
	LookupEnvironmentHistory  []gax.CallOption
	RunContinuousTest         []gax.CallOption
	ListContinuousTestResults []gax.CallOption
	DeployFlow                []gax.CallOption
}

EnvironmentsCallOptions contains the retry settings for each method of EnvironmentsClient.

type EnvironmentsClient

type EnvironmentsClient struct {

	// The call options for this service.
	CallOptions *EnvironmentsCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

EnvironmentsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Environments.

func NewEnvironmentsClient

func NewEnvironmentsClient(ctx context.Context, opts ...option.ClientOption) (*EnvironmentsClient, error)

NewEnvironmentsClient creates a new environments client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Environments.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*EnvironmentsClient) Close

func (c *EnvironmentsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*EnvironmentsClient) Connection

func (c *EnvironmentsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*EnvironmentsClient) CreateEnvironment

CreateEnvironment creates an Environment in the specified Agent.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: An empty Struct
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: Environment
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateEnvironmentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateEnvironmentRequest.
	}
	op, err := c.CreateEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EnvironmentsClient) CreateEnvironmentOperation

func (c *EnvironmentsClient) CreateEnvironmentOperation(name string) *CreateEnvironmentOperation

CreateEnvironmentOperation returns a new CreateEnvironmentOperation from a given name. The name must be that of a previously created CreateEnvironmentOperation, possibly from a different process.

func (*EnvironmentsClient) DeleteEnvironment

func (c *EnvironmentsClient) DeleteEnvironment(ctx context.Context, req *cxpb.DeleteEnvironmentRequest, opts ...gax.CallOption) error

DeleteEnvironment deletes the specified Environment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteEnvironmentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteEnvironmentRequest.
	}
	err = c.DeleteEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*EnvironmentsClient) DeployFlow added in v1.1.0

DeployFlow deploys a flow to the specified Environment.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: DeployFlowMetadata

response: DeployFlowResponse
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeployFlowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeployFlowRequest.
	}
	op, err := c.DeployFlow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EnvironmentsClient) DeployFlowOperation added in v1.1.0

func (c *EnvironmentsClient) DeployFlowOperation(name string) *DeployFlowOperation

DeployFlowOperation returns a new DeployFlowOperation from a given name. The name must be that of a previously created DeployFlowOperation, possibly from a different process.

func (*EnvironmentsClient) GetEnvironment

func (c *EnvironmentsClient) GetEnvironment(ctx context.Context, req *cxpb.GetEnvironmentRequest, opts ...gax.CallOption) (*cxpb.Environment, error)

GetEnvironment retrieves the specified Environment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetEnvironmentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetEnvironmentRequest.
	}
	resp, err := c.GetEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EnvironmentsClient) ListContinuousTestResults

ListContinuousTestResults fetches a list of continuous test results for a given environment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListContinuousTestResultsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListContinuousTestResultsRequest.
	}
	it := c.ListContinuousTestResults(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*EnvironmentsClient) ListEnvironments

ListEnvironments returns the list of all environments in the specified Agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListEnvironmentsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListEnvironmentsRequest.
	}
	it := c.ListEnvironments(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*EnvironmentsClient) LookupEnvironmentHistory

LookupEnvironmentHistory looks up the history of the specified Environment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.LookupEnvironmentHistoryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#LookupEnvironmentHistoryRequest.
	}
	it := c.LookupEnvironmentHistory(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*EnvironmentsClient) RunContinuousTest

RunContinuousTest kicks off a continuous test under the specified Environment.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: RunContinuousTestMetadata

response: RunContinuousTestResponse
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.RunContinuousTestRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#RunContinuousTestRequest.
	}
	op, err := c.RunContinuousTest(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EnvironmentsClient) RunContinuousTestOperation

func (c *EnvironmentsClient) RunContinuousTestOperation(name string) *RunContinuousTestOperation

RunContinuousTestOperation returns a new RunContinuousTestOperation from a given name. The name must be that of a previously created RunContinuousTestOperation, possibly from a different process.

func (*EnvironmentsClient) UpdateEnvironment

UpdateEnvironment updates the specified Environment.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: An empty Struct
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: Environment
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateEnvironmentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateEnvironmentRequest.
	}
	op, err := c.UpdateEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EnvironmentsClient) UpdateEnvironmentOperation

func (c *EnvironmentsClient) UpdateEnvironmentOperation(name string) *UpdateEnvironmentOperation

UpdateEnvironmentOperation returns a new UpdateEnvironmentOperation from a given name. The name must be that of a previously created UpdateEnvironmentOperation, possibly from a different process.

type ExperimentIterator

type ExperimentIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.Experiment, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ExperimentIterator manages a stream of *cxpb.Experiment.

func (*ExperimentIterator) Next

func (it *ExperimentIterator) Next() (*cxpb.Experiment, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*ExperimentIterator) PageInfo

func (it *ExperimentIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type ExperimentsCallOptions

type ExperimentsCallOptions struct {
	ListExperiments  []gax.CallOption
	GetExperiment    []gax.CallOption
	CreateExperiment []gax.CallOption
	UpdateExperiment []gax.CallOption
	DeleteExperiment []gax.CallOption
	StartExperiment  []gax.CallOption
	StopExperiment   []gax.CallOption
}

ExperimentsCallOptions contains the retry settings for each method of ExperimentsClient.

type ExperimentsClient

type ExperimentsClient struct {

	// The call options for this service.
	CallOptions *ExperimentsCallOptions
	// contains filtered or unexported fields
}

ExperimentsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Experiments.

func NewExperimentsClient

func NewExperimentsClient(ctx context.Context, opts ...option.ClientOption) (*ExperimentsClient, error)

NewExperimentsClient creates a new experiments client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Experiments.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewExperimentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*ExperimentsClient) Close

func (c *ExperimentsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*ExperimentsClient) Connection

func (c *ExperimentsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*ExperimentsClient) CreateExperiment

func (c *ExperimentsClient) CreateExperiment(ctx context.Context, req *cxpb.CreateExperimentRequest, opts ...gax.CallOption) (*cxpb.Experiment, error)

CreateExperiment creates an Experiment in the specified Environment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewExperimentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateExperimentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateExperimentRequest.
	}
	resp, err := c.CreateExperiment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ExperimentsClient) DeleteExperiment

func (c *ExperimentsClient) DeleteExperiment(ctx context.Context, req *cxpb.DeleteExperimentRequest, opts ...gax.CallOption) error

DeleteExperiment deletes the specified Experiment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewExperimentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteExperimentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteExperimentRequest.
	}
	err = c.DeleteExperiment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*ExperimentsClient) GetExperiment

func (c *ExperimentsClient) GetExperiment(ctx context.Context, req *cxpb.GetExperimentRequest, opts ...gax.CallOption) (*cxpb.Experiment, error)

GetExperiment retrieves the specified Experiment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewExperimentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetExperimentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetExperimentRequest.
	}
	resp, err := c.GetExperiment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ExperimentsClient) ListExperiments

ListExperiments returns the list of all experiments in the specified Environment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewExperimentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListExperimentsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListExperimentsRequest.
	}
	it := c.ListExperiments(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*ExperimentsClient) StartExperiment

func (c *ExperimentsClient) StartExperiment(ctx context.Context, req *cxpb.StartExperimentRequest, opts ...gax.CallOption) (*cxpb.Experiment, error)

StartExperiment starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewExperimentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.StartExperimentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#StartExperimentRequest.
	}
	resp, err := c.StartExperiment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ExperimentsClient) StopExperiment

func (c *ExperimentsClient) StopExperiment(ctx context.Context, req *cxpb.StopExperimentRequest, opts ...gax.CallOption) (*cxpb.Experiment, error)

StopExperiment stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewExperimentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.StopExperimentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#StopExperimentRequest.
	}
	resp, err := c.StopExperiment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ExperimentsClient) UpdateExperiment

func (c *ExperimentsClient) UpdateExperiment(ctx context.Context, req *cxpb.UpdateExperimentRequest, opts ...gax.CallOption) (*cxpb.Experiment, error)

UpdateExperiment updates the specified Experiment.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewExperimentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateExperimentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateExperimentRequest.
	}
	resp, err := c.UpdateExperiment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type ExportAgentOperation

type ExportAgentOperation struct {
	// contains filtered or unexported fields
}

ExportAgentOperation manages a long-running operation from ExportAgent.

func (*ExportAgentOperation) Done

func (op *ExportAgentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ExportAgentOperation) Metadata

func (op *ExportAgentOperation) Metadata() (*structpb.Struct, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*ExportAgentOperation) Name

func (op *ExportAgentOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*ExportAgentOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*ExportAgentOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type ExportFlowOperation

type ExportFlowOperation struct {
	// contains filtered or unexported fields
}

ExportFlowOperation manages a long-running operation from ExportFlow.

func (*ExportFlowOperation) Done

func (op *ExportFlowOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ExportFlowOperation) Metadata

func (op *ExportFlowOperation) Metadata() (*structpb.Struct, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*ExportFlowOperation) Name

func (op *ExportFlowOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*ExportFlowOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*ExportFlowOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type ExportTestCasesOperation

type ExportTestCasesOperation struct {
	// contains filtered or unexported fields
}

ExportTestCasesOperation manages a long-running operation from ExportTestCases.

func (*ExportTestCasesOperation) Done

func (op *ExportTestCasesOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ExportTestCasesOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*ExportTestCasesOperation) Name

func (op *ExportTestCasesOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*ExportTestCasesOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*ExportTestCasesOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type FlowIterator

type FlowIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.Flow, nextPageToken string, err error)
	// contains filtered or unexported fields
}

FlowIterator manages a stream of *cxpb.Flow.

func (*FlowIterator) Next

func (it *FlowIterator) Next() (*cxpb.Flow, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*FlowIterator) PageInfo

func (it *FlowIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type FlowsCallOptions

type FlowsCallOptions struct {
	CreateFlow              []gax.CallOption
	DeleteFlow              []gax.CallOption
	ListFlows               []gax.CallOption
	GetFlow                 []gax.CallOption
	UpdateFlow              []gax.CallOption
	TrainFlow               []gax.CallOption
	ValidateFlow            []gax.CallOption
	GetFlowValidationResult []gax.CallOption
	ImportFlow              []gax.CallOption
	ExportFlow              []gax.CallOption
}

FlowsCallOptions contains the retry settings for each method of FlowsClient.

type FlowsClient

type FlowsClient struct {

	// The call options for this service.
	CallOptions *FlowsCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

FlowsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Flows.

func NewFlowsClient

func NewFlowsClient(ctx context.Context, opts ...option.ClientOption) (*FlowsClient, error)

NewFlowsClient creates a new flows client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Flows.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*FlowsClient) Close

func (c *FlowsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*FlowsClient) Connection

func (c *FlowsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*FlowsClient) CreateFlow

func (c *FlowsClient) CreateFlow(ctx context.Context, req *cxpb.CreateFlowRequest, opts ...gax.CallOption) (*cxpb.Flow, error)

CreateFlow creates a flow in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateFlowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateFlowRequest.
	}
	resp, err := c.CreateFlow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*FlowsClient) DeleteFlow

func (c *FlowsClient) DeleteFlow(ctx context.Context, req *cxpb.DeleteFlowRequest, opts ...gax.CallOption) error

DeleteFlow deletes a specified flow.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteFlowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteFlowRequest.
	}
	err = c.DeleteFlow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*FlowsClient) ExportFlow

ExportFlow exports the specified flow to a binary file.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: An empty Struct
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: ExportFlowResponse

Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ExportFlowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ExportFlowRequest.
	}
	op, err := c.ExportFlow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*FlowsClient) ExportFlowOperation

func (c *FlowsClient) ExportFlowOperation(name string) *ExportFlowOperation

ExportFlowOperation returns a new ExportFlowOperation from a given name. The name must be that of a previously created ExportFlowOperation, possibly from a different process.

func (*FlowsClient) GetFlow

func (c *FlowsClient) GetFlow(ctx context.Context, req *cxpb.GetFlowRequest, opts ...gax.CallOption) (*cxpb.Flow, error)

GetFlow retrieves the specified flow.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetFlowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetFlowRequest.
	}
	resp, err := c.GetFlow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*FlowsClient) GetFlowValidationResult

func (c *FlowsClient) GetFlowValidationResult(ctx context.Context, req *cxpb.GetFlowValidationResultRequest, opts ...gax.CallOption) (*cxpb.FlowValidationResult, error)

GetFlowValidationResult gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetFlowValidationResultRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetFlowValidationResultRequest.
	}
	resp, err := c.GetFlowValidationResult(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*FlowsClient) ImportFlow

ImportFlow imports the specified flow to the specified agent from a binary file.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: An empty Struct
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: ImportFlowResponse

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ImportFlowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ImportFlowRequest.
	}
	op, err := c.ImportFlow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*FlowsClient) ImportFlowOperation

func (c *FlowsClient) ImportFlowOperation(name string) *ImportFlowOperation

ImportFlowOperation returns a new ImportFlowOperation from a given name. The name must be that of a previously created ImportFlowOperation, possibly from a different process.

func (*FlowsClient) ListFlows

func (c *FlowsClient) ListFlows(ctx context.Context, req *cxpb.ListFlowsRequest, opts ...gax.CallOption) *FlowIterator

ListFlows returns the list of all flows in the specified agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListFlowsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListFlowsRequest.
	}
	it := c.ListFlows(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*FlowsClient) TrainFlow

func (c *FlowsClient) TrainFlow(ctx context.Context, req *cxpb.TrainFlowRequest, opts ...gax.CallOption) (*TrainFlowOperation, error)

TrainFlow trains the specified flow. Note that only the flow in ‘draft’ environment is trained.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: An empty Struct
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: An Empty
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.TrainFlowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#TrainFlowRequest.
	}
	op, err := c.TrainFlow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*FlowsClient) TrainFlowOperation

func (c *FlowsClient) TrainFlowOperation(name string) *TrainFlowOperation

TrainFlowOperation returns a new TrainFlowOperation from a given name. The name must be that of a previously created TrainFlowOperation, possibly from a different process.

func (*FlowsClient) UpdateFlow

func (c *FlowsClient) UpdateFlow(ctx context.Context, req *cxpb.UpdateFlowRequest, opts ...gax.CallOption) (*cxpb.Flow, error)

UpdateFlow updates the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateFlowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateFlowRequest.
	}
	resp, err := c.UpdateFlow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*FlowsClient) ValidateFlow

ValidateFlow validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewFlowsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ValidateFlowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ValidateFlowRequest.
	}
	resp, err := c.ValidateFlow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type ImportFlowOperation

type ImportFlowOperation struct {
	// contains filtered or unexported fields
}

ImportFlowOperation manages a long-running operation from ImportFlow.

func (*ImportFlowOperation) Done

func (op *ImportFlowOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ImportFlowOperation) Metadata

func (op *ImportFlowOperation) Metadata() (*structpb.Struct, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*ImportFlowOperation) Name

func (op *ImportFlowOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*ImportFlowOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*ImportFlowOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type ImportTestCasesOperation

type ImportTestCasesOperation struct {
	// contains filtered or unexported fields
}

ImportTestCasesOperation manages a long-running operation from ImportTestCases.

func (*ImportTestCasesOperation) Done

func (op *ImportTestCasesOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ImportTestCasesOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*ImportTestCasesOperation) Name

func (op *ImportTestCasesOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*ImportTestCasesOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*ImportTestCasesOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type IntentIterator

type IntentIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.Intent, nextPageToken string, err error)
	// contains filtered or unexported fields
}

IntentIterator manages a stream of *cxpb.Intent.

func (*IntentIterator) Next

func (it *IntentIterator) Next() (*cxpb.Intent, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*IntentIterator) PageInfo

func (it *IntentIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type IntentsCallOptions

type IntentsCallOptions struct {
	ListIntents  []gax.CallOption
	GetIntent    []gax.CallOption
	CreateIntent []gax.CallOption
	UpdateIntent []gax.CallOption
	DeleteIntent []gax.CallOption
}

IntentsCallOptions contains the retry settings for each method of IntentsClient.

type IntentsClient

type IntentsClient struct {

	// The call options for this service.
	CallOptions *IntentsCallOptions
	// contains filtered or unexported fields
}

IntentsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Intents.

func NewIntentsClient

func NewIntentsClient(ctx context.Context, opts ...option.ClientOption) (*IntentsClient, error)

NewIntentsClient creates a new intents client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Intents.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*IntentsClient) Close

func (c *IntentsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*IntentsClient) Connection

func (c *IntentsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*IntentsClient) CreateIntent

func (c *IntentsClient) CreateIntent(ctx context.Context, req *cxpb.CreateIntentRequest, opts ...gax.CallOption) (*cxpb.Intent, error)

CreateIntent creates an intent in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateIntentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateIntentRequest.
	}
	resp, err := c.CreateIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*IntentsClient) DeleteIntent

func (c *IntentsClient) DeleteIntent(ctx context.Context, req *cxpb.DeleteIntentRequest, opts ...gax.CallOption) error

DeleteIntent deletes the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteIntentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteIntentRequest.
	}
	err = c.DeleteIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*IntentsClient) GetIntent

func (c *IntentsClient) GetIntent(ctx context.Context, req *cxpb.GetIntentRequest, opts ...gax.CallOption) (*cxpb.Intent, error)

GetIntent retrieves the specified intent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetIntentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetIntentRequest.
	}
	resp, err := c.GetIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*IntentsClient) ListIntents

func (c *IntentsClient) ListIntents(ctx context.Context, req *cxpb.ListIntentsRequest, opts ...gax.CallOption) *IntentIterator

ListIntents returns the list of all intents in the specified agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListIntentsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListIntentsRequest.
	}
	it := c.ListIntents(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*IntentsClient) UpdateIntent

func (c *IntentsClient) UpdateIntent(ctx context.Context, req *cxpb.UpdateIntentRequest, opts ...gax.CallOption) (*cxpb.Intent, error)

UpdateIntent updates the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateIntentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateIntentRequest.
	}
	resp, err := c.UpdateIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type LoadVersionOperation

type LoadVersionOperation struct {
	// contains filtered or unexported fields
}

LoadVersionOperation manages a long-running operation from LoadVersion.

func (*LoadVersionOperation) Done

func (op *LoadVersionOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*LoadVersionOperation) Metadata

func (op *LoadVersionOperation) Metadata() (*structpb.Struct, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*LoadVersionOperation) Name

func (op *LoadVersionOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*LoadVersionOperation) Poll

func (op *LoadVersionOperation) Poll(ctx context.Context, opts ...gax.CallOption) error

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*LoadVersionOperation) Wait

func (op *LoadVersionOperation) Wait(ctx context.Context, opts ...gax.CallOption) error

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type PageIterator

type PageIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.Page, nextPageToken string, err error)
	// contains filtered or unexported fields
}

PageIterator manages a stream of *cxpb.Page.

func (*PageIterator) Next

func (it *PageIterator) Next() (*cxpb.Page, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*PageIterator) PageInfo

func (it *PageIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type PagesCallOptions

type PagesCallOptions struct {
	ListPages  []gax.CallOption
	GetPage    []gax.CallOption
	CreatePage []gax.CallOption
	UpdatePage []gax.CallOption
	DeletePage []gax.CallOption
}

PagesCallOptions contains the retry settings for each method of PagesClient.

type PagesClient

type PagesClient struct {

	// The call options for this service.
	CallOptions *PagesCallOptions
	// contains filtered or unexported fields
}

PagesClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing [Pages][google.cloud.dialogflow.cx.v3.Page (at http://google.cloud.dialogflow.cx.v3.Page)].

func NewPagesClient

func NewPagesClient(ctx context.Context, opts ...option.ClientOption) (*PagesClient, error)

NewPagesClient creates a new pages client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing [Pages][google.cloud.dialogflow.cx.v3.Page (at http://google.cloud.dialogflow.cx.v3.Page)].

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewPagesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*PagesClient) Close

func (c *PagesClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*PagesClient) Connection

func (c *PagesClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*PagesClient) CreatePage

func (c *PagesClient) CreatePage(ctx context.Context, req *cxpb.CreatePageRequest, opts ...gax.CallOption) (*cxpb.Page, error)

CreatePage creates a page in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewPagesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreatePageRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreatePageRequest.
	}
	resp, err := c.CreatePage(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*PagesClient) DeletePage

func (c *PagesClient) DeletePage(ctx context.Context, req *cxpb.DeletePageRequest, opts ...gax.CallOption) error

DeletePage deletes the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewPagesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeletePageRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeletePageRequest.
	}
	err = c.DeletePage(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*PagesClient) GetPage

func (c *PagesClient) GetPage(ctx context.Context, req *cxpb.GetPageRequest, opts ...gax.CallOption) (*cxpb.Page, error)

GetPage retrieves the specified page.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewPagesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetPageRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetPageRequest.
	}
	resp, err := c.GetPage(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*PagesClient) ListPages

func (c *PagesClient) ListPages(ctx context.Context, req *cxpb.ListPagesRequest, opts ...gax.CallOption) *PageIterator

ListPages returns the list of all pages in the specified flow.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewPagesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListPagesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListPagesRequest.
	}
	it := c.ListPages(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*PagesClient) UpdatePage

func (c *PagesClient) UpdatePage(ctx context.Context, req *cxpb.UpdatePageRequest, opts ...gax.CallOption) (*cxpb.Page, error)

UpdatePage updates the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewPagesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdatePageRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdatePageRequest.
	}
	resp, err := c.UpdatePage(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type RestoreAgentOperation

type RestoreAgentOperation struct {
	// contains filtered or unexported fields
}

RestoreAgentOperation manages a long-running operation from RestoreAgent.

func (*RestoreAgentOperation) Done

func (op *RestoreAgentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RestoreAgentOperation) Metadata

func (op *RestoreAgentOperation) Metadata() (*structpb.Struct, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*RestoreAgentOperation) Name

func (op *RestoreAgentOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*RestoreAgentOperation) Poll

func (op *RestoreAgentOperation) Poll(ctx context.Context, opts ...gax.CallOption) error

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*RestoreAgentOperation) Wait

func (op *RestoreAgentOperation) Wait(ctx context.Context, opts ...gax.CallOption) error

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type RunContinuousTestOperation

type RunContinuousTestOperation struct {
	// contains filtered or unexported fields
}

RunContinuousTestOperation manages a long-running operation from RunContinuousTest.

func (*RunContinuousTestOperation) Done

func (op *RunContinuousTestOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RunContinuousTestOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*RunContinuousTestOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*RunContinuousTestOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*RunContinuousTestOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type RunTestCaseOperation

type RunTestCaseOperation struct {
	// contains filtered or unexported fields
}

RunTestCaseOperation manages a long-running operation from RunTestCase.

func (*RunTestCaseOperation) Done

func (op *RunTestCaseOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RunTestCaseOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*RunTestCaseOperation) Name

func (op *RunTestCaseOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*RunTestCaseOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*RunTestCaseOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type SecuritySettingsCallOptions

type SecuritySettingsCallOptions struct {
	CreateSecuritySettings []gax.CallOption
	GetSecuritySettings    []gax.CallOption
	UpdateSecuritySettings []gax.CallOption
	ListSecuritySettings   []gax.CallOption
	DeleteSecuritySettings []gax.CallOption
}

SecuritySettingsCallOptions contains the retry settings for each method of SecuritySettingsClient.

type SecuritySettingsClient

type SecuritySettingsClient struct {

	// The call options for this service.
	CallOptions *SecuritySettingsCallOptions
	// contains filtered or unexported fields
}

SecuritySettingsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing security settings for Dialogflow.

func NewSecuritySettingsClient

func NewSecuritySettingsClient(ctx context.Context, opts ...option.ClientOption) (*SecuritySettingsClient, error)

NewSecuritySettingsClient creates a new security settings service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing security settings for Dialogflow.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSecuritySettingsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*SecuritySettingsClient) Close

func (c *SecuritySettingsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*SecuritySettingsClient) Connection

func (c *SecuritySettingsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*SecuritySettingsClient) CreateSecuritySettings

CreateSecuritySettings create security settings in the specified location.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSecuritySettingsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateSecuritySettingsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateSecuritySettingsRequest.
	}
	resp, err := c.CreateSecuritySettings(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*SecuritySettingsClient) DeleteSecuritySettings

func (c *SecuritySettingsClient) DeleteSecuritySettings(ctx context.Context, req *cxpb.DeleteSecuritySettingsRequest, opts ...gax.CallOption) error

DeleteSecuritySettings deletes the specified SecuritySettings.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSecuritySettingsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteSecuritySettingsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteSecuritySettingsRequest.
	}
	err = c.DeleteSecuritySettings(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*SecuritySettingsClient) GetSecuritySettings

GetSecuritySettings retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSecuritySettingsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetSecuritySettingsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetSecuritySettingsRequest.
	}
	resp, err := c.GetSecuritySettings(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*SecuritySettingsClient) ListSecuritySettings

ListSecuritySettings returns the list of all security settings in the specified location.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSecuritySettingsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListSecuritySettingsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListSecuritySettingsRequest.
	}
	it := c.ListSecuritySettings(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*SecuritySettingsClient) UpdateSecuritySettings

UpdateSecuritySettings updates the specified SecuritySettings.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSecuritySettingsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateSecuritySettingsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateSecuritySettingsRequest.
	}
	resp, err := c.UpdateSecuritySettings(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type SecuritySettingsIterator

type SecuritySettingsIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.SecuritySettings, nextPageToken string, err error)
	// contains filtered or unexported fields
}

SecuritySettingsIterator manages a stream of *cxpb.SecuritySettings.

func (*SecuritySettingsIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*SecuritySettingsIterator) PageInfo

func (it *SecuritySettingsIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type SessionEntityTypeIterator

type SessionEntityTypeIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.SessionEntityType, nextPageToken string, err error)
	// contains filtered or unexported fields
}

SessionEntityTypeIterator manages a stream of *cxpb.SessionEntityType.

func (*SessionEntityTypeIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*SessionEntityTypeIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type SessionEntityTypesCallOptions

type SessionEntityTypesCallOptions struct {
	ListSessionEntityTypes  []gax.CallOption
	GetSessionEntityType    []gax.CallOption
	CreateSessionEntityType []gax.CallOption
	UpdateSessionEntityType []gax.CallOption
	DeleteSessionEntityType []gax.CallOption
}

SessionEntityTypesCallOptions contains the retry settings for each method of SessionEntityTypesClient.

type SessionEntityTypesClient

type SessionEntityTypesClient struct {

	// The call options for this service.
	CallOptions *SessionEntityTypesCallOptions
	// contains filtered or unexported fields
}

SessionEntityTypesClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing SessionEntityTypes.

func NewSessionEntityTypesClient

func NewSessionEntityTypesClient(ctx context.Context, opts ...option.ClientOption) (*SessionEntityTypesClient, error)

NewSessionEntityTypesClient creates a new session entity types client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing SessionEntityTypes.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*SessionEntityTypesClient) Close

func (c *SessionEntityTypesClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*SessionEntityTypesClient) Connection

func (c *SessionEntityTypesClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*SessionEntityTypesClient) CreateSessionEntityType

CreateSessionEntityType creates a session entity type.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateSessionEntityTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateSessionEntityTypeRequest.
	}
	resp, err := c.CreateSessionEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*SessionEntityTypesClient) DeleteSessionEntityType

func (c *SessionEntityTypesClient) DeleteSessionEntityType(ctx context.Context, req *cxpb.DeleteSessionEntityTypeRequest, opts ...gax.CallOption) error

DeleteSessionEntityType deletes the specified session entity type.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteSessionEntityTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteSessionEntityTypeRequest.
	}
	err = c.DeleteSessionEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*SessionEntityTypesClient) GetSessionEntityType

GetSessionEntityType retrieves the specified session entity type.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetSessionEntityTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetSessionEntityTypeRequest.
	}
	resp, err := c.GetSessionEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*SessionEntityTypesClient) ListSessionEntityTypes

ListSessionEntityTypes returns the list of all session entity types in the specified session.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListSessionEntityTypesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListSessionEntityTypesRequest.
	}
	it := c.ListSessionEntityTypes(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*SessionEntityTypesClient) UpdateSessionEntityType

UpdateSessionEntityType updates the specified session entity type.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateSessionEntityTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateSessionEntityTypeRequest.
	}
	resp, err := c.UpdateSessionEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type SessionsCallOptions

type SessionsCallOptions struct {
	DetectIntent          []gax.CallOption
	StreamingDetectIntent []gax.CallOption
	MatchIntent           []gax.CallOption
	FulfillIntent         []gax.CallOption
}

SessionsCallOptions contains the retry settings for each method of SessionsClient.

type SessionsClient

type SessionsClient struct {

	// The call options for this service.
	CallOptions *SessionsCallOptions
	// contains filtered or unexported fields
}

SessionsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

A session represents an interaction with a user. You retrieve user input and pass it to the DetectIntent method to determine user intent and respond.

func NewSessionsClient

func NewSessionsClient(ctx context.Context, opts ...option.ClientOption) (*SessionsClient, error)

NewSessionsClient creates a new sessions client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

A session represents an interaction with a user. You retrieve user input and pass it to the DetectIntent method to determine user intent and respond.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*SessionsClient) Close

func (c *SessionsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*SessionsClient) Connection

func (c *SessionsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*SessionsClient) DetectIntent

DetectIntent processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.

Note: Always use agent versions for production traffic. See Versions and environments (at https://cloud.google.com/dialogflow/cx/docs/concept/version).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DetectIntentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DetectIntentRequest.
	}
	resp, err := c.DetectIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*SessionsClient) FulfillIntent

FulfillIntent fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.FulfillIntentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#FulfillIntentRequest.
	}
	resp, err := c.FulfillIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*SessionsClient) MatchIntent

MatchIntent returns preliminary intent match results, doesn’t change the session status.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.MatchIntentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#MatchIntentRequest.
	}
	resp, err := c.MatchIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*SessionsClient) StreamingDetectIntent

func (c *SessionsClient) StreamingDetectIntent(ctx context.Context, opts ...gax.CallOption) (cxpb.Sessions_StreamingDetectIntentClient, error)

StreamingDetectIntent processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

Note: Always use agent versions for production traffic. See Versions and environments (at https://cloud.google.com/dialogflow/cx/docs/concept/version).

Example
package main

import (
	"context"
	"io"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewSessionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()
	stream, err := c.StreamingDetectIntent(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	go func() {
		reqs := []*cxpb.StreamingDetectIntentRequest{
			// TODO: Create requests.
		}
		for _, req := range reqs {
			if err := stream.Send(req); err != nil {
				// TODO: Handle error.
			}
		}
		stream.CloseSend()
	}()
	for {
		resp, err := stream.Recv()
		if err == io.EOF {
			break
		}
		if err != nil {
			// TODO: handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

type TestCaseIterator

type TestCaseIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.TestCase, nextPageToken string, err error)
	// contains filtered or unexported fields
}

TestCaseIterator manages a stream of *cxpb.TestCase.

func (*TestCaseIterator) Next

func (it *TestCaseIterator) Next() (*cxpb.TestCase, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*TestCaseIterator) PageInfo

func (it *TestCaseIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type TestCaseResultIterator

type TestCaseResultIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.TestCaseResult, nextPageToken string, err error)
	// contains filtered or unexported fields
}

TestCaseResultIterator manages a stream of *cxpb.TestCaseResult.

func (*TestCaseResultIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*TestCaseResultIterator) PageInfo

func (it *TestCaseResultIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type TestCasesCallOptions

type TestCasesCallOptions struct {
	ListTestCases        []gax.CallOption
	BatchDeleteTestCases []gax.CallOption
	GetTestCase          []gax.CallOption
	CreateTestCase       []gax.CallOption
	UpdateTestCase       []gax.CallOption
	RunTestCase          []gax.CallOption
	BatchRunTestCases    []gax.CallOption
	CalculateCoverage    []gax.CallOption
	ImportTestCases      []gax.CallOption
	ExportTestCases      []gax.CallOption
	ListTestCaseResults  []gax.CallOption
	GetTestCaseResult    []gax.CallOption
}

TestCasesCallOptions contains the retry settings for each method of TestCasesClient.

type TestCasesClient

type TestCasesClient struct {

	// The call options for this service.
	CallOptions *TestCasesCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

TestCasesClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing [Test Cases][google.cloud.dialogflow.cx.v3.TestCase] and [Test Case Results][google.cloud.dialogflow.cx.v3.TestCaseResult].

func NewTestCasesClient

func NewTestCasesClient(ctx context.Context, opts ...option.ClientOption) (*TestCasesClient, error)

NewTestCasesClient creates a new test cases client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing [Test Cases][google.cloud.dialogflow.cx.v3.TestCase] and [Test Case Results][google.cloud.dialogflow.cx.v3.TestCaseResult].

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*TestCasesClient) BatchDeleteTestCases

func (c *TestCasesClient) BatchDeleteTestCases(ctx context.Context, req *cxpb.BatchDeleteTestCasesRequest, opts ...gax.CallOption) error

BatchDeleteTestCases batch deletes test cases.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.BatchDeleteTestCasesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#BatchDeleteTestCasesRequest.
	}
	err = c.BatchDeleteTestCases(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*TestCasesClient) BatchRunTestCases

BatchRunTestCases kicks off a batch run of test cases.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: BatchRunTestCasesMetadata

response: BatchRunTestCasesResponse
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.BatchRunTestCasesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#BatchRunTestCasesRequest.
	}
	op, err := c.BatchRunTestCases(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*TestCasesClient) BatchRunTestCasesOperation

func (c *TestCasesClient) BatchRunTestCasesOperation(name string) *BatchRunTestCasesOperation

BatchRunTestCasesOperation returns a new BatchRunTestCasesOperation from a given name. The name must be that of a previously created BatchRunTestCasesOperation, possibly from a different process.

func (*TestCasesClient) CalculateCoverage

CalculateCoverage calculates the test coverage for an agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CalculateCoverageRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CalculateCoverageRequest.
	}
	resp, err := c.CalculateCoverage(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*TestCasesClient) Close

func (c *TestCasesClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*TestCasesClient) Connection

func (c *TestCasesClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*TestCasesClient) CreateTestCase

func (c *TestCasesClient) CreateTestCase(ctx context.Context, req *cxpb.CreateTestCaseRequest, opts ...gax.CallOption) (*cxpb.TestCase, error)

CreateTestCase creates a test case for the given agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateTestCaseRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateTestCaseRequest.
	}
	resp, err := c.CreateTestCase(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*TestCasesClient) ExportTestCases

ExportTestCases exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: ExportTestCasesMetadata

response: ExportTestCasesResponse
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ExportTestCasesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ExportTestCasesRequest.
	}
	op, err := c.ExportTestCases(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*TestCasesClient) ExportTestCasesOperation

func (c *TestCasesClient) ExportTestCasesOperation(name string) *ExportTestCasesOperation

ExportTestCasesOperation returns a new ExportTestCasesOperation from a given name. The name must be that of a previously created ExportTestCasesOperation, possibly from a different process.

func (*TestCasesClient) GetTestCase

func (c *TestCasesClient) GetTestCase(ctx context.Context, req *cxpb.GetTestCaseRequest, opts ...gax.CallOption) (*cxpb.TestCase, error)

GetTestCase gets a test case.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetTestCaseRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetTestCaseRequest.
	}
	resp, err := c.GetTestCase(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*TestCasesClient) GetTestCaseResult

func (c *TestCasesClient) GetTestCaseResult(ctx context.Context, req *cxpb.GetTestCaseResultRequest, opts ...gax.CallOption) (*cxpb.TestCaseResult, error)

GetTestCaseResult gets a test case result.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetTestCaseResultRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetTestCaseResultRequest.
	}
	resp, err := c.GetTestCaseResult(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*TestCasesClient) ImportTestCases

ImportTestCases imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won’t overwrite any existing ones. The provided ID in the imported test case is neglected.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: ImportTestCasesMetadata

response: ImportTestCasesResponse
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ImportTestCasesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ImportTestCasesRequest.
	}
	op, err := c.ImportTestCases(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*TestCasesClient) ImportTestCasesOperation

func (c *TestCasesClient) ImportTestCasesOperation(name string) *ImportTestCasesOperation

ImportTestCasesOperation returns a new ImportTestCasesOperation from a given name. The name must be that of a previously created ImportTestCasesOperation, possibly from a different process.

func (*TestCasesClient) ListTestCaseResults

ListTestCaseResults fetches a list of results for a given test case.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListTestCaseResultsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListTestCaseResultsRequest.
	}
	it := c.ListTestCaseResults(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*TestCasesClient) ListTestCases

ListTestCases fetches a list of test cases for a given agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListTestCasesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListTestCasesRequest.
	}
	it := c.ListTestCases(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*TestCasesClient) RunTestCase

RunTestCase kicks off a test case run.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: RunTestCaseMetadata

response: RunTestCaseResponse
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.RunTestCaseRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#RunTestCaseRequest.
	}
	op, err := c.RunTestCase(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*TestCasesClient) RunTestCaseOperation

func (c *TestCasesClient) RunTestCaseOperation(name string) *RunTestCaseOperation

RunTestCaseOperation returns a new RunTestCaseOperation from a given name. The name must be that of a previously created RunTestCaseOperation, possibly from a different process.

func (*TestCasesClient) UpdateTestCase

func (c *TestCasesClient) UpdateTestCase(ctx context.Context, req *cxpb.UpdateTestCaseRequest, opts ...gax.CallOption) (*cxpb.TestCase, error)

UpdateTestCase updates the specified test case.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTestCasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateTestCaseRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateTestCaseRequest.
	}
	resp, err := c.UpdateTestCase(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type TrainFlowOperation

type TrainFlowOperation struct {
	// contains filtered or unexported fields
}

TrainFlowOperation manages a long-running operation from TrainFlow.

func (*TrainFlowOperation) Done

func (op *TrainFlowOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*TrainFlowOperation) Metadata

func (op *TrainFlowOperation) Metadata() (*structpb.Struct, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*TrainFlowOperation) Name

func (op *TrainFlowOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*TrainFlowOperation) Poll

func (op *TrainFlowOperation) Poll(ctx context.Context, opts ...gax.CallOption) error

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*TrainFlowOperation) Wait

func (op *TrainFlowOperation) Wait(ctx context.Context, opts ...gax.CallOption) error

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type TransitionRouteGroupIterator

type TransitionRouteGroupIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.TransitionRouteGroup, nextPageToken string, err error)
	// contains filtered or unexported fields
}

TransitionRouteGroupIterator manages a stream of *cxpb.TransitionRouteGroup.

func (*TransitionRouteGroupIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*TransitionRouteGroupIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type TransitionRouteGroupsCallOptions

type TransitionRouteGroupsCallOptions struct {
	ListTransitionRouteGroups  []gax.CallOption
	GetTransitionRouteGroup    []gax.CallOption
	CreateTransitionRouteGroup []gax.CallOption
	UpdateTransitionRouteGroup []gax.CallOption
	DeleteTransitionRouteGroup []gax.CallOption
}

TransitionRouteGroupsCallOptions contains the retry settings for each method of TransitionRouteGroupsClient.

type TransitionRouteGroupsClient

type TransitionRouteGroupsClient struct {

	// The call options for this service.
	CallOptions *TransitionRouteGroupsCallOptions
	// contains filtered or unexported fields
}

TransitionRouteGroupsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing TransitionRouteGroups.

func NewTransitionRouteGroupsClient

func NewTransitionRouteGroupsClient(ctx context.Context, opts ...option.ClientOption) (*TransitionRouteGroupsClient, error)

NewTransitionRouteGroupsClient creates a new transition route groups client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing TransitionRouteGroups.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTransitionRouteGroupsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*TransitionRouteGroupsClient) Close

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*TransitionRouteGroupsClient) Connection

func (c *TransitionRouteGroupsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*TransitionRouteGroupsClient) CreateTransitionRouteGroup

CreateTransitionRouteGroup creates an TransitionRouteGroup in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTransitionRouteGroupsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateTransitionRouteGroupRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateTransitionRouteGroupRequest.
	}
	resp, err := c.CreateTransitionRouteGroup(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*TransitionRouteGroupsClient) DeleteTransitionRouteGroup

func (c *TransitionRouteGroupsClient) DeleteTransitionRouteGroup(ctx context.Context, req *cxpb.DeleteTransitionRouteGroupRequest, opts ...gax.CallOption) error

DeleteTransitionRouteGroup deletes the specified TransitionRouteGroup.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTransitionRouteGroupsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteTransitionRouteGroupRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteTransitionRouteGroupRequest.
	}
	err = c.DeleteTransitionRouteGroup(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*TransitionRouteGroupsClient) GetTransitionRouteGroup

GetTransitionRouteGroup retrieves the specified TransitionRouteGroup.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTransitionRouteGroupsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetTransitionRouteGroupRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetTransitionRouteGroupRequest.
	}
	resp, err := c.GetTransitionRouteGroup(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*TransitionRouteGroupsClient) ListTransitionRouteGroups

ListTransitionRouteGroups returns the list of all transition route groups in the specified flow.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTransitionRouteGroupsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListTransitionRouteGroupsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListTransitionRouteGroupsRequest.
	}
	it := c.ListTransitionRouteGroups(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*TransitionRouteGroupsClient) UpdateTransitionRouteGroup

UpdateTransitionRouteGroup updates the specified TransitionRouteGroup.

Note: You should always train a flow prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/cx/docs/concept/training).

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewTransitionRouteGroupsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateTransitionRouteGroupRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateTransitionRouteGroupRequest.
	}
	resp, err := c.UpdateTransitionRouteGroup(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type UpdateEnvironmentOperation

type UpdateEnvironmentOperation struct {
	// contains filtered or unexported fields
}

UpdateEnvironmentOperation manages a long-running operation from UpdateEnvironment.

func (*UpdateEnvironmentOperation) Done

func (op *UpdateEnvironmentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateEnvironmentOperation) Metadata

func (op *UpdateEnvironmentOperation) Metadata() (*structpb.Struct, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*UpdateEnvironmentOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*UpdateEnvironmentOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*UpdateEnvironmentOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type VersionIterator

type VersionIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.Version, nextPageToken string, err error)
	// contains filtered or unexported fields
}

VersionIterator manages a stream of *cxpb.Version.

func (*VersionIterator) Next

func (it *VersionIterator) Next() (*cxpb.Version, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*VersionIterator) PageInfo

func (it *VersionIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type VersionsCallOptions

type VersionsCallOptions struct {
	ListVersions    []gax.CallOption
	GetVersion      []gax.CallOption
	CreateVersion   []gax.CallOption
	UpdateVersion   []gax.CallOption
	DeleteVersion   []gax.CallOption
	LoadVersion     []gax.CallOption
	CompareVersions []gax.CallOption
}

VersionsCallOptions contains the retry settings for each method of VersionsClient.

type VersionsClient

type VersionsClient struct {

	// The call options for this service.
	CallOptions *VersionsCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

VersionsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Versions.

func NewVersionsClient

func NewVersionsClient(ctx context.Context, opts ...option.ClientOption) (*VersionsClient, error)

NewVersionsClient creates a new versions client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Versions.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*VersionsClient) Close

func (c *VersionsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*VersionsClient) CompareVersions added in v1.3.0

CompareVersions compares the specified base version with target version.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CompareVersionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CompareVersionsRequest.
	}
	resp, err := c.CompareVersions(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*VersionsClient) Connection

func (c *VersionsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*VersionsClient) CreateVersion

CreateVersion creates a Version in the specified Flow.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: CreateVersionOperationMetadata

response: Version
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateVersionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateVersionRequest.
	}
	op, err := c.CreateVersion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*VersionsClient) CreateVersionOperation

func (c *VersionsClient) CreateVersionOperation(name string) *CreateVersionOperation

CreateVersionOperation returns a new CreateVersionOperation from a given name. The name must be that of a previously created CreateVersionOperation, possibly from a different process.

func (*VersionsClient) DeleteVersion

func (c *VersionsClient) DeleteVersion(ctx context.Context, req *cxpb.DeleteVersionRequest, opts ...gax.CallOption) error

DeleteVersion deletes the specified Version.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteVersionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteVersionRequest.
	}
	err = c.DeleteVersion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*VersionsClient) GetVersion

func (c *VersionsClient) GetVersion(ctx context.Context, req *cxpb.GetVersionRequest, opts ...gax.CallOption) (*cxpb.Version, error)

GetVersion retrieves the specified Version.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetVersionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetVersionRequest.
	}
	resp, err := c.GetVersion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*VersionsClient) ListVersions

func (c *VersionsClient) ListVersions(ctx context.Context, req *cxpb.ListVersionsRequest, opts ...gax.CallOption) *VersionIterator

ListVersions returns the list of all versions in the specified Flow.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListVersionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListVersionsRequest.
	}
	it := c.ListVersions(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*VersionsClient) LoadVersion

LoadVersion loads resources in the specified version to the draft flow.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: An empty Struct
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: An Empty
message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.LoadVersionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#LoadVersionRequest.
	}
	op, err := c.LoadVersion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*VersionsClient) LoadVersionOperation

func (c *VersionsClient) LoadVersionOperation(name string) *LoadVersionOperation

LoadVersionOperation returns a new LoadVersionOperation from a given name. The name must be that of a previously created LoadVersionOperation, possibly from a different process.

func (*VersionsClient) UpdateVersion

func (c *VersionsClient) UpdateVersion(ctx context.Context, req *cxpb.UpdateVersionRequest, opts ...gax.CallOption) (*cxpb.Version, error)

UpdateVersion updates the specified Version.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateVersionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateVersionRequest.
	}
	resp, err := c.UpdateVersion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type WebhookIterator

type WebhookIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*cxpb.Webhook, nextPageToken string, err error)
	// contains filtered or unexported fields
}

WebhookIterator manages a stream of *cxpb.Webhook.

func (*WebhookIterator) Next

func (it *WebhookIterator) Next() (*cxpb.Webhook, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*WebhookIterator) PageInfo

func (it *WebhookIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type WebhooksCallOptions

type WebhooksCallOptions struct {
	ListWebhooks  []gax.CallOption
	GetWebhook    []gax.CallOption
	CreateWebhook []gax.CallOption
	UpdateWebhook []gax.CallOption
	DeleteWebhook []gax.CallOption
}

WebhooksCallOptions contains the retry settings for each method of WebhooksClient.

type WebhooksClient

type WebhooksClient struct {

	// The call options for this service.
	CallOptions *WebhooksCallOptions
	// contains filtered or unexported fields
}

WebhooksClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Webhooks.

func NewWebhooksClient

func NewWebhooksClient(ctx context.Context, opts ...option.ClientOption) (*WebhooksClient, error)

NewWebhooksClient creates a new webhooks client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Webhooks.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewWebhooksClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}
Output:

func (*WebhooksClient) Close

func (c *WebhooksClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*WebhooksClient) Connection

func (c *WebhooksClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*WebhooksClient) CreateWebhook

func (c *WebhooksClient) CreateWebhook(ctx context.Context, req *cxpb.CreateWebhookRequest, opts ...gax.CallOption) (*cxpb.Webhook, error)

CreateWebhook creates a webhook in the specified agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewWebhooksClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.CreateWebhookRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#CreateWebhookRequest.
	}
	resp, err := c.CreateWebhook(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*WebhooksClient) DeleteWebhook

func (c *WebhooksClient) DeleteWebhook(ctx context.Context, req *cxpb.DeleteWebhookRequest, opts ...gax.CallOption) error

DeleteWebhook deletes the specified webhook.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewWebhooksClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.DeleteWebhookRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#DeleteWebhookRequest.
	}
	err = c.DeleteWebhook(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*WebhooksClient) GetWebhook

func (c *WebhooksClient) GetWebhook(ctx context.Context, req *cxpb.GetWebhookRequest, opts ...gax.CallOption) (*cxpb.Webhook, error)

GetWebhook retrieves the specified webhook.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewWebhooksClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.GetWebhookRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#GetWebhookRequest.
	}
	resp, err := c.GetWebhook(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*WebhooksClient) ListWebhooks

func (c *WebhooksClient) ListWebhooks(ctx context.Context, req *cxpb.ListWebhooksRequest, opts ...gax.CallOption) *WebhookIterator

ListWebhooks returns the list of all webhooks in the specified agent.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	"google.golang.org/api/iterator"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewWebhooksClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.ListWebhooksRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#ListWebhooksRequest.
	}
	it := c.ListWebhooks(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*WebhooksClient) UpdateWebhook

func (c *WebhooksClient) UpdateWebhook(ctx context.Context, req *cxpb.UpdateWebhookRequest, opts ...gax.CallOption) (*cxpb.Webhook, error)

UpdateWebhook updates the specified webhook.

Example
package main

import (
	"context"

	cx "cloud.google.com/go/dialogflow/cx/apiv3"
	cxpb "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3"
)

func main() {
	ctx := context.Background()
	c, err := cx.NewWebhooksClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &cxpb.UpdateWebhookRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#UpdateWebhookRequest.
	}
	resp, err := c.UpdateWebhook(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL