...

Package contactcenteraiplatform

import "google.golang.org/api/contactcenteraiplatform/v1alpha1"
Overview
Index

Overview ▾

Package contactcenteraiplatform provides access to the Contact Center AI Platform API.

For product documentation, see: https://cloud.google.com/solutions/contact-center-ai-platform

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/contactcenteraiplatform/v1alpha1"
...
ctx := context.Background()
contactcenteraiplatformService, err := contactcenteraiplatform.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

contactcenteraiplatformService, err := contactcenteraiplatform.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
contactcenteraiplatformService, err := contactcenteraiplatform.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index ▾

Constants
type AdminUser
    func (s *AdminUser) MarshalJSON() ([]byte, error)
type CancelOperationRequest
type ContactCenter
    func (s *ContactCenter) MarshalJSON() ([]byte, error)
type ContactCenterQuota
    func (s *ContactCenterQuota) MarshalJSON() ([]byte, error)
type Early
type Empty
type GoogleCloudCommonOperationMetadata
    func (s *GoogleCloudCommonOperationMetadata) MarshalJSON() ([]byte, error)
type InstanceConfig
    func (s *InstanceConfig) MarshalJSON() ([]byte, error)
type ListContactCentersResponse
    func (s *ListContactCentersResponse) MarshalJSON() ([]byte, error)
type ListLocationsResponse
    func (s *ListLocationsResponse) MarshalJSON() ([]byte, error)
type ListOperationsResponse
    func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
type Location
    func (s *Location) MarshalJSON() ([]byte, error)
type Normal
type Operation
    func (s *Operation) MarshalJSON() ([]byte, error)
type OperationMetadata
    func (s *OperationMetadata) MarshalJSON() ([]byte, error)
type ProjectsLocationsContactCentersCreateCall
    func (c *ProjectsLocationsContactCentersCreateCall) ContactCenterId(contactCenterId string) *ProjectsLocationsContactCentersCreateCall
    func (c *ProjectsLocationsContactCentersCreateCall) Context(ctx context.Context) *ProjectsLocationsContactCentersCreateCall
    func (c *ProjectsLocationsContactCentersCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
    func (c *ProjectsLocationsContactCentersCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsContactCentersCreateCall
    func (c *ProjectsLocationsContactCentersCreateCall) Header() http.Header
    func (c *ProjectsLocationsContactCentersCreateCall) RequestId(requestId string) *ProjectsLocationsContactCentersCreateCall
type ProjectsLocationsContactCentersDeleteCall
    func (c *ProjectsLocationsContactCentersDeleteCall) Context(ctx context.Context) *ProjectsLocationsContactCentersDeleteCall
    func (c *ProjectsLocationsContactCentersDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
    func (c *ProjectsLocationsContactCentersDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsContactCentersDeleteCall
    func (c *ProjectsLocationsContactCentersDeleteCall) Header() http.Header
    func (c *ProjectsLocationsContactCentersDeleteCall) RequestId(requestId string) *ProjectsLocationsContactCentersDeleteCall
type ProjectsLocationsContactCentersGetCall
    func (c *ProjectsLocationsContactCentersGetCall) Context(ctx context.Context) *ProjectsLocationsContactCentersGetCall
    func (c *ProjectsLocationsContactCentersGetCall) Do(opts ...googleapi.CallOption) (*ContactCenter, error)
    func (c *ProjectsLocationsContactCentersGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsContactCentersGetCall
    func (c *ProjectsLocationsContactCentersGetCall) Header() http.Header
    func (c *ProjectsLocationsContactCentersGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsContactCentersGetCall
type ProjectsLocationsContactCentersListCall
    func (c *ProjectsLocationsContactCentersListCall) Context(ctx context.Context) *ProjectsLocationsContactCentersListCall
    func (c *ProjectsLocationsContactCentersListCall) Do(opts ...googleapi.CallOption) (*ListContactCentersResponse, error)
    func (c *ProjectsLocationsContactCentersListCall) Fields(s ...googleapi.Field) *ProjectsLocationsContactCentersListCall
    func (c *ProjectsLocationsContactCentersListCall) Filter(filter string) *ProjectsLocationsContactCentersListCall
    func (c *ProjectsLocationsContactCentersListCall) Header() http.Header
    func (c *ProjectsLocationsContactCentersListCall) IfNoneMatch(entityTag string) *ProjectsLocationsContactCentersListCall
    func (c *ProjectsLocationsContactCentersListCall) OrderBy(orderBy string) *ProjectsLocationsContactCentersListCall
    func (c *ProjectsLocationsContactCentersListCall) PageSize(pageSize int64) *ProjectsLocationsContactCentersListCall
    func (c *ProjectsLocationsContactCentersListCall) PageToken(pageToken string) *ProjectsLocationsContactCentersListCall
    func (c *ProjectsLocationsContactCentersListCall) Pages(ctx context.Context, f func(*ListContactCentersResponse) error) error
type ProjectsLocationsContactCentersPatchCall
    func (c *ProjectsLocationsContactCentersPatchCall) Context(ctx context.Context) *ProjectsLocationsContactCentersPatchCall
    func (c *ProjectsLocationsContactCentersPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
    func (c *ProjectsLocationsContactCentersPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsContactCentersPatchCall
    func (c *ProjectsLocationsContactCentersPatchCall) Header() http.Header
    func (c *ProjectsLocationsContactCentersPatchCall) RequestId(requestId string) *ProjectsLocationsContactCentersPatchCall
    func (c *ProjectsLocationsContactCentersPatchCall) UpdateMask(updateMask string) *ProjectsLocationsContactCentersPatchCall
type ProjectsLocationsContactCentersService
    func NewProjectsLocationsContactCentersService(s *Service) *ProjectsLocationsContactCentersService
    func (r *ProjectsLocationsContactCentersService) Create(parent string, contactcenter *ContactCenter) *ProjectsLocationsContactCentersCreateCall
    func (r *ProjectsLocationsContactCentersService) Delete(name string) *ProjectsLocationsContactCentersDeleteCall
    func (r *ProjectsLocationsContactCentersService) Get(name string) *ProjectsLocationsContactCentersGetCall
    func (r *ProjectsLocationsContactCentersService) List(parent string) *ProjectsLocationsContactCentersListCall
    func (r *ProjectsLocationsContactCentersService) Patch(name string, contactcenter *ContactCenter) *ProjectsLocationsContactCentersPatchCall
type ProjectsLocationsGetCall
    func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
    func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
    func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
    func (c *ProjectsLocationsGetCall) Header() http.Header
    func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall
type ProjectsLocationsListCall
    func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
    func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
    func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
    func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
    func (c *ProjectsLocationsListCall) Header() http.Header
    func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall
    func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
    func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
    func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error
type ProjectsLocationsOperationsCancelCall
    func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall
    func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
    func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall
    func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header
type ProjectsLocationsOperationsDeleteCall
    func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall
    func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
    func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall
    func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header
type ProjectsLocationsOperationsGetCall
    func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
    func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
    func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
    func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
    func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
type ProjectsLocationsOperationsListCall
    func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
    func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
    func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
    func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
    func (c *ProjectsLocationsOperationsListCall) Header() http.Header
    func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
    func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
    func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
    func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
type ProjectsLocationsOperationsService
    func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService
    func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall
    func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall
    func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
    func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
type ProjectsLocationsQueryContactCenterQuotaCall
    func (c *ProjectsLocationsQueryContactCenterQuotaCall) Context(ctx context.Context) *ProjectsLocationsQueryContactCenterQuotaCall
    func (c *ProjectsLocationsQueryContactCenterQuotaCall) Do(opts ...googleapi.CallOption) (*ContactCenterQuota, error)
    func (c *ProjectsLocationsQueryContactCenterQuotaCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueryContactCenterQuotaCall
    func (c *ProjectsLocationsQueryContactCenterQuotaCall) Header() http.Header
    func (c *ProjectsLocationsQueryContactCenterQuotaCall) IfNoneMatch(entityTag string) *ProjectsLocationsQueryContactCenterQuotaCall
type ProjectsLocationsService
    func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
    func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall
    func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall
    func (r *ProjectsLocationsService) QueryContactCenterQuota(parent string) *ProjectsLocationsQueryContactCenterQuotaCall
type ProjectsService
    func NewProjectsService(s *Service) *ProjectsService
type Quota
    func (s *Quota) MarshalJSON() ([]byte, error)
type SAMLParams
    func (s *SAMLParams) MarshalJSON() ([]byte, error)
type Service
    func New(client *http.Client) (*Service, error)
    func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
type Status
    func (s *Status) MarshalJSON() ([]byte, error)
type URIs
    func (s *URIs) MarshalJSON() ([]byte, error)

Package files

contactcenteraiplatform-gen.go

Constants

OAuth2 scopes used by this API.

const (
    // See, edit, configure, and delete your Google Cloud data and see the email
    // address for your Google Account.
    CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

type AdminUser

AdminUser: Message storing info about the first admin user. Next ID: 3

type AdminUser struct {
    // FamilyName: Optional. Last/family name of the first admin user.
    FamilyName string `json:"familyName,omitempty"`
    // GivenName: Optional. First/given name of the first admin user.
    GivenName string `json:"givenName,omitempty"`
    // ForceSendFields is a list of field names (e.g. "FamilyName") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "FamilyName") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*AdminUser) MarshalJSON

func (s *AdminUser) MarshalJSON() ([]byte, error)

type CancelOperationRequest

CancelOperationRequest: The request message for Operations.CancelOperation.

type CancelOperationRequest struct {
}

type ContactCenter

ContactCenter: Message describing ContactCenter object Next ID: 22

type ContactCenter struct {
    // AdminUser: Optional. Info about the first admin user, such as given name and
    // family name.
    AdminUser *AdminUser `json:"adminUser,omitempty"`
    // CcaipManagedUsers: Optional. Whether to enable users to be created in the
    // CCAIP-instance concurrently to having users in Cloud identity
    CcaipManagedUsers bool `json:"ccaipManagedUsers,omitempty"`
    // CreateTime: Output only. [Output only] Create time stamp
    CreateTime string `json:"createTime,omitempty"`
    // CustomerDomainPrefix: Required. Immutable. At least 2 and max 16 char long,
    // must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).
    CustomerDomainPrefix string `json:"customerDomainPrefix,omitempty"`
    // DisplayName: Required. A user friendly name for the ContactCenter.
    DisplayName string `json:"displayName,omitempty"`
    // Early: Optional. Early release channel.
    Early *Early `json:"early,omitempty"`
    // InstanceConfig: The configuration of this instance, it is currently
    // immutable once created.
    InstanceConfig *InstanceConfig `json:"instanceConfig,omitempty"`
    // KmsKey: Immutable. The KMS key name to encrypt the user input
    // (`ContactCenter`).
    KmsKey string `json:"kmsKey,omitempty"`
    // Labels: Labels as key value pairs
    Labels map[string]string `json:"labels,omitempty"`
    // Name: name of resource
    Name string `json:"name,omitempty"`
    // Normal: Optional. Normal release channel.
    Normal *Normal `json:"normal,omitempty"`
    // PrivateComponents: Output only. A list of UJET components that should be
    // privately accessed. This field is set by reading settings from the data
    // plane. For more information about the format of the component please refer
    // to go/ccaip-vpc-sc-org-policy. This field is must be fully populated only
    // for Create/Update resource operations. The main use case for this field is
    // OrgPolicy checks via CPE.
    PrivateComponents []string `json:"privateComponents,omitempty"`
    // SamlParams: Optional. Params that sets up Google as IdP.
    SamlParams *SAMLParams `json:"samlParams,omitempty"`
    // State: Output only. The state of this contact center.
    //
    // Possible values:
    //   "STATE_UNSPECIFIED" - The default value. This value is used if the state
    // is omitted.
    //   "STATE_DEPLOYING" - State DEPLOYING
    //   "STATE_DEPLOYED" - State DEPLOYED
    //   "STATE_TERMINATING" - State TERMINATING
    //   "STATE_FAILED" - State FAILED
    //   "STATE_TERMINATING_FAILED" - State TERMINATING_FAILED
    //   "STATE_TERMINATED" - State TERMINATED
    //   "STATE_IN_GRACE_PERIOD" - State IN_GRACE_PERIOD
    State string `json:"state,omitempty"`
    // UpdateTime: Output only. [Output only] Update time stamp
    UpdateTime string `json:"updateTime,omitempty"`
    // Uris: Output only. URIs to access the deployed ContactCenters.
    Uris *URIs `json:"uris,omitempty"`
    // UserEmail: Optional. Email address of the first admin user.
    UserEmail string `json:"userEmail,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "AdminUser") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AdminUser") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ContactCenter) MarshalJSON

func (s *ContactCenter) MarshalJSON() ([]byte, error)

type ContactCenterQuota

ContactCenterQuota: Represents a quota for contact centers.

type ContactCenterQuota struct {
    // ContactCenterCountLimit: Deprecated: Use the Quota fields instead. Reflects
    // the count limit of contact centers on a billing account.
    ContactCenterCountLimit int64 `json:"contactCenterCountLimit,omitempty"`
    // ContactCenterCountSum: Deprecated: Use the Quota fields instead. Reflects
    // the count sum of contact centers on a billing account.
    ContactCenterCountSum int64 `json:"contactCenterCountSum,omitempty"`
    // Quotas: Quota details per contact center instance type.
    Quotas []*Quota `json:"quotas,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "ContactCenterCountLimit") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ContactCenterCountLimit") to
    // include in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ContactCenterQuota) MarshalJSON

func (s *ContactCenterQuota) MarshalJSON() ([]byte, error)

type Early

Early: First Channel to receive the updates. Meant to dev/test instances

type Early struct {
}

type Empty

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type Empty struct {
    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
}

type GoogleCloudCommonOperationMetadata

GoogleCloudCommonOperationMetadata: Represents the metadata of the long-running operation.

type GoogleCloudCommonOperationMetadata struct {
    // ApiVersion: Output only. API version used to start the operation.
    ApiVersion string `json:"apiVersion,omitempty"`
    // CancelRequested: Output only. Identifies whether the user has requested
    // cancellation of the operation. Operations that have been cancelled
    // successfully have Operation.error value with a google.rpc.Status.code of 1,
    // corresponding to `Code.CANCELLED`.
    CancelRequested bool `json:"cancelRequested,omitempty"`
    // CreateTime: Output only. The time the operation was created.
    CreateTime string `json:"createTime,omitempty"`
    // EndTime: Output only. The time the operation finished running.
    EndTime string `json:"endTime,omitempty"`
    // StatusDetail: Output only. Human-readable status of the operation, if any.
    StatusDetail string `json:"statusDetail,omitempty"`
    // Target: Output only. Server-defined resource path for the target of the
    // operation.
    Target string `json:"target,omitempty"`
    // Verb: Output only. Name of the verb executed by the operation.
    Verb string `json:"verb,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ApiVersion") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ApiVersion") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GoogleCloudCommonOperationMetadata) MarshalJSON

func (s *GoogleCloudCommonOperationMetadata) MarshalJSON() ([]byte, error)

type InstanceConfig

InstanceConfig: Message storing the instance configuration.

type InstanceConfig struct {
    // InstanceSize: The instance size of this the instance configuration.
    //
    // Possible values:
    //   "INSTANCE_SIZE_UNSPECIFIED" - The default value. This value is used if the
    // state is omitted.
    //   "STANDARD_SMALL" - Instance Size STANDARD_SMALL.
    //   "STANDARD_MEDIUM" - Instance Size STANDARD_MEDIUM.
    //   "STANDARD_LARGE" - Instance Size STANDARD_LARGE.
    //   "STANDARD_XLARGE" - Instance Size STANDARD_XLARGE.
    //   "STANDARD_2XLARGE" - Instance Size STANDARD_2XLARGE.
    //   "STANDARD_3XLARGE" - Instance Size STANDARD_3XLARGE.
    //   "DEV_XSMALL" - Instance Size DEV_EXTRA_SMALL.
    //   "MULTIREGION_SMALL" - Instance Size MULTIREGION_SMALL
    //   "MULTIREGION_MEDIUM" - Instance Size MULTIREGION_MEDIUM
    //   "MULTIREGION_LARGE" - Instance Size MULTIREGION_LARGE
    //   "MULTIREGION_XLARGE" - Instance Size MULTIREGION_XLARGE
    //   "MULTIREGION_2XLARGE" - Instance Size MULTIREGION_2XLARGE.
    //   "MULTIREGION_3XLARGE" - Instance Size MULTIREGION_3XLARGE.
    InstanceSize string `json:"instanceSize,omitempty"`
    // ForceSendFields is a list of field names (e.g. "InstanceSize") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "InstanceSize") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*InstanceConfig) MarshalJSON

func (s *InstanceConfig) MarshalJSON() ([]byte, error)

type ListContactCentersResponse

ListContactCentersResponse: Message for response to listing ContactCenters

type ListContactCentersResponse struct {
    // ContactCenters: The list of ContactCenter
    ContactCenters []*ContactCenter `json:"contactCenters,omitempty"`
    // NextPageToken: A token identifying a page of results the server should
    // return.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // Unreachable: Locations that could not be reached.
    Unreachable []string `json:"unreachable,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "ContactCenters") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ContactCenters") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListContactCentersResponse) MarshalJSON

func (s *ListContactCentersResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse

ListLocationsResponse: The response message for Locations.ListLocations.

type ListLocationsResponse struct {
    // Locations: A list of locations that matches the specified filter in the
    // request.
    Locations []*Location `json:"locations,omitempty"`
    // NextPageToken: The standard List next-page token.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Locations") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Locations") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListLocationsResponse) MarshalJSON

func (s *ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse

ListOperationsResponse: The response message for Operations.ListOperations.

type ListOperationsResponse struct {
    // NextPageToken: The standard List next-page token.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // Operations: A list of operations that matches the specified filter in the
    // request.
    Operations []*Operation `json:"operations,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "NextPageToken") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListOperationsResponse) MarshalJSON

func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)

type Location

Location: A resource that represents a Google Cloud location.

type Location struct {
    // DisplayName: The friendly name for this location, typically a nearby city
    // name. For example, "Tokyo".
    DisplayName string `json:"displayName,omitempty"`
    // Labels: Cross-service attributes for the location. For example
    // {"cloud.googleapis.com/region": "us-east1"}
    Labels map[string]string `json:"labels,omitempty"`
    // LocationId: The canonical id for this location. For example: "us-east1".
    LocationId string `json:"locationId,omitempty"`
    // Metadata: Service-specific metadata. For example the available capacity at
    // the given location.
    Metadata googleapi.RawMessage `json:"metadata,omitempty"`
    // Name: Resource name for the location, which may vary between
    // implementations. For example:
    // "projects/example-project/locations/us-east1"
    Name string `json:"name,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "DisplayName") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DisplayName") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Location) MarshalJSON

func (s *Location) MarshalJSON() ([]byte, error)

type Normal

Normal: Instances in this Channel will receive updates after all instances in `Early` were updated + 2 days.

type Normal struct {
}

type Operation

Operation: This resource represents a long-running operation that is the result of a network API call.

type Operation struct {
    // Done: If the value is `false`, it means the operation is still in progress.
    // If `true`, the operation is completed, and either `error` or `response` is
    // available.
    Done bool `json:"done,omitempty"`
    // Error: The error result of the operation in case of failure or cancellation.
    Error *Status `json:"error,omitempty"`
    // Metadata: Service-specific metadata associated with the operation. It
    // typically contains progress information and common metadata such as create
    // time. Some services might not provide such metadata. Any method that returns
    // a long-running operation should document the metadata type, if any.
    Metadata googleapi.RawMessage `json:"metadata,omitempty"`
    // Name: The server-assigned name, which is only unique within the same service
    // that originally returns it. If you use the default HTTP mapping, the `name`
    // should be a resource name ending with `operations/{unique_id}`.
    Name string `json:"name,omitempty"`
    // Response: The normal, successful response of the operation. If the original
    // method returns no data on success, such as `Delete`, the response is
    // `google.protobuf.Empty`. If the original method is standard
    // `Get`/`Create`/`Update`, the response should be the resource. For other
    // methods, the response should have the type `XxxResponse`, where `Xxx` is the
    // original method name. For example, if the original method name is
    // `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    Response googleapi.RawMessage `json:"response,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Done") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Done") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Operation) MarshalJSON

func (s *Operation) MarshalJSON() ([]byte, error)

type OperationMetadata

OperationMetadata: Represents the metadata of the long-running operation.

type OperationMetadata struct {
    // ApiVersion: Output only. API version used to start the operation.
    ApiVersion string `json:"apiVersion,omitempty"`
    // ContactCenter: Contact center information for this request
    ContactCenter *ContactCenter `json:"contactCenter,omitempty"`
    // CreateTime: Output only. The time the operation was created.
    CreateTime string `json:"createTime,omitempty"`
    // EndTime: Output only. The time the operation finished running.
    EndTime string `json:"endTime,omitempty"`
    // RequestedCancellation: Output only. Identifies whether the user has
    // requested cancellation of the operation. Operations that have been cancelled
    // successfully have Operation.error value with a google.rpc.Status.code of 1,
    // corresponding to `Code.CANCELLED`.
    RequestedCancellation bool `json:"requestedCancellation,omitempty"`
    // StatusMessage: Output only. Human-readable status of the operation, if any.
    StatusMessage string `json:"statusMessage,omitempty"`
    // Target: Output only. Server-defined resource path for the target of the
    // operation.
    Target string `json:"target,omitempty"`
    // Verb: Output only. Name of the verb executed by the operation.
    Verb string `json:"verb,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ApiVersion") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ApiVersion") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*OperationMetadata) MarshalJSON

func (s *OperationMetadata) MarshalJSON() ([]byte, error)

type ProjectsLocationsContactCentersCreateCall

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

func (*ProjectsLocationsContactCentersCreateCall) ContactCenterId

func (c *ProjectsLocationsContactCentersCreateCall) ContactCenterId(contactCenterId string) *ProjectsLocationsContactCentersCreateCall

ContactCenterId sets the optional parameter "contactCenterId": Required. Id of the requesting object If auto-generating Id server-side, remove this field and contact_center_id from the method_signature of Create RPC

func (*ProjectsLocationsContactCentersCreateCall) Context

func (c *ProjectsLocationsContactCentersCreateCall) Context(ctx context.Context) *ProjectsLocationsContactCentersCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsContactCentersCreateCall) Do

func (c *ProjectsLocationsContactCentersCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "contactcenteraiplatform.projects.locations.contactCenters.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsContactCentersCreateCall) Fields

func (c *ProjectsLocationsContactCentersCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsContactCentersCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsContactCentersCreateCall) Header

func (c *ProjectsLocationsContactCentersCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsContactCentersCreateCall) RequestId

func (c *ProjectsLocationsContactCentersCreateCall) RequestId(requestId string) *ProjectsLocationsContactCentersCreateCall

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsContactCentersDeleteCall

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

func (*ProjectsLocationsContactCentersDeleteCall) Context

func (c *ProjectsLocationsContactCentersDeleteCall) Context(ctx context.Context) *ProjectsLocationsContactCentersDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsContactCentersDeleteCall) Do

func (c *ProjectsLocationsContactCentersDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "contactcenteraiplatform.projects.locations.contactCenters.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsContactCentersDeleteCall) Fields

func (c *ProjectsLocationsContactCentersDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsContactCentersDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsContactCentersDeleteCall) Header

func (c *ProjectsLocationsContactCentersDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsContactCentersDeleteCall) RequestId

func (c *ProjectsLocationsContactCentersDeleteCall) RequestId(requestId string) *ProjectsLocationsContactCentersDeleteCall

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsContactCentersGetCall

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

func (*ProjectsLocationsContactCentersGetCall) Context

func (c *ProjectsLocationsContactCentersGetCall) Context(ctx context.Context) *ProjectsLocationsContactCentersGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsContactCentersGetCall) Do

func (c *ProjectsLocationsContactCentersGetCall) Do(opts ...googleapi.CallOption) (*ContactCenter, error)

Do executes the "contactcenteraiplatform.projects.locations.contactCenters.get" call. Any non-2xx status code is an error. Response headers are in either *ContactCenter.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsContactCentersGetCall) Fields

func (c *ProjectsLocationsContactCentersGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsContactCentersGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsContactCentersGetCall) Header

func (c *ProjectsLocationsContactCentersGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsContactCentersGetCall) IfNoneMatch

func (c *ProjectsLocationsContactCentersGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsContactCentersGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsContactCentersListCall

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

func (*ProjectsLocationsContactCentersListCall) Context

func (c *ProjectsLocationsContactCentersListCall) Context(ctx context.Context) *ProjectsLocationsContactCentersListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsContactCentersListCall) Do

func (c *ProjectsLocationsContactCentersListCall) Do(opts ...googleapi.CallOption) (*ListContactCentersResponse, error)

Do executes the "contactcenteraiplatform.projects.locations.contactCenters.list" call. Any non-2xx status code is an error. Response headers are in either *ListContactCentersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsContactCentersListCall) Fields

func (c *ProjectsLocationsContactCentersListCall) Fields(s ...googleapi.Field) *ProjectsLocationsContactCentersListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsContactCentersListCall) Filter

func (c *ProjectsLocationsContactCentersListCall) Filter(filter string) *ProjectsLocationsContactCentersListCall

Filter sets the optional parameter "filter": Filtering results

func (*ProjectsLocationsContactCentersListCall) Header

func (c *ProjectsLocationsContactCentersListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsContactCentersListCall) IfNoneMatch

func (c *ProjectsLocationsContactCentersListCall) IfNoneMatch(entityTag string) *ProjectsLocationsContactCentersListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsContactCentersListCall) OrderBy

func (c *ProjectsLocationsContactCentersListCall) OrderBy(orderBy string) *ProjectsLocationsContactCentersListCall

OrderBy sets the optional parameter "orderBy": Hint for how to order the results

func (*ProjectsLocationsContactCentersListCall) PageSize

func (c *ProjectsLocationsContactCentersListCall) PageSize(pageSize int64) *ProjectsLocationsContactCentersListCall

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsContactCentersListCall) PageToken

func (c *ProjectsLocationsContactCentersListCall) PageToken(pageToken string) *ProjectsLocationsContactCentersListCall

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return.

func (*ProjectsLocationsContactCentersListCall) Pages

func (c *ProjectsLocationsContactCentersListCall) Pages(ctx context.Context, f func(*ListContactCentersResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsContactCentersPatchCall

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

func (*ProjectsLocationsContactCentersPatchCall) Context

func (c *ProjectsLocationsContactCentersPatchCall) Context(ctx context.Context) *ProjectsLocationsContactCentersPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsContactCentersPatchCall) Do

func (c *ProjectsLocationsContactCentersPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "contactcenteraiplatform.projects.locations.contactCenters.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsContactCentersPatchCall) Fields

func (c *ProjectsLocationsContactCentersPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsContactCentersPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsContactCentersPatchCall) Header

func (c *ProjectsLocationsContactCentersPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsContactCentersPatchCall) RequestId

func (c *ProjectsLocationsContactCentersPatchCall) RequestId(requestId string) *ProjectsLocationsContactCentersPatchCall

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsContactCentersPatchCall) UpdateMask

func (c *ProjectsLocationsContactCentersPatchCall) UpdateMask(updateMask string) *ProjectsLocationsContactCentersPatchCall

UpdateMask sets the optional parameter "updateMask": Required. Field mask is used to specify the fields to be overwritten in the ContactCenter resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

type ProjectsLocationsContactCentersService

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

func NewProjectsLocationsContactCentersService

func NewProjectsLocationsContactCentersService(s *Service) *ProjectsLocationsContactCentersService

func (*ProjectsLocationsContactCentersService) Create

func (r *ProjectsLocationsContactCentersService) Create(parent string, contactcenter *ContactCenter) *ProjectsLocationsContactCentersCreateCall

Create: Creates a new ContactCenter in a given project and location.

- parent: Value for parent.

func (*ProjectsLocationsContactCentersService) Delete

func (r *ProjectsLocationsContactCentersService) Delete(name string) *ProjectsLocationsContactCentersDeleteCall

Delete: Deletes a single ContactCenter.

- name: Name of the resource.

func (*ProjectsLocationsContactCentersService) Get

func (r *ProjectsLocationsContactCentersService) Get(name string) *ProjectsLocationsContactCentersGetCall

Get: Gets details of a single ContactCenter.

- name: Name of the resource.

func (*ProjectsLocationsContactCentersService) List

func (r *ProjectsLocationsContactCentersService) List(parent string) *ProjectsLocationsContactCentersListCall

List: Lists ContactCenters in a given project and location.

- parent: Parent value for ListContactCentersRequest.

func (*ProjectsLocationsContactCentersService) Patch

func (r *ProjectsLocationsContactCentersService) Patch(name string, contactcenter *ContactCenter) *ProjectsLocationsContactCentersPatchCall

Patch: Updates the parameters of a single ContactCenter.

- name: name of resource.

type ProjectsLocationsGetCall

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

func (*ProjectsLocationsGetCall) Context

func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall) Do

func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)

Do executes the "contactcenteraiplatform.projects.locations.get" call. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall) Fields

func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetCall) Header

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsListCall

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

func (*ProjectsLocationsListCall) Context

func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall) Do

func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)

Do executes the "contactcenteraiplatform.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields

func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter

func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header

func (c *ProjectsLocationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsListCall) PageSize

func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken

func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages

func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOperationsCancelCall

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

func (*ProjectsLocationsOperationsCancelCall) Context

func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsCancelCall) Do

func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "contactcenteraiplatform.projects.locations.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsCancelCall) Fields

func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsCancelCall) Header

func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsDeleteCall

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

func (*ProjectsLocationsOperationsDeleteCall) Context

func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsDeleteCall) Do

func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "contactcenteraiplatform.projects.locations.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsDeleteCall) Fields

func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsDeleteCall) Header

func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsGetCall

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

func (*ProjectsLocationsOperationsGetCall) Context

func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall) Do

func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "contactcenteraiplatform.projects.locations.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall) Fields

func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsGetCall) Header

func (c *ProjectsLocationsOperationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch

func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall) Context

func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall) Do

func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

Do executes the "contactcenteraiplatform.projects.locations.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall) Fields

func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsListCall) Filter

func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall) Header

func (c *ProjectsLocationsOperationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsListCall) IfNoneMatch

func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall) PageSize

func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsOperationsListCall) PageToken

func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsOperationsListCall) Pages

func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOperationsService

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

func NewProjectsLocationsOperationsService

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Cancel

func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService) Delete

func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService) Get

func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService) List

func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type ProjectsLocationsQueryContactCenterQuotaCall

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

func (*ProjectsLocationsQueryContactCenterQuotaCall) Context

func (c *ProjectsLocationsQueryContactCenterQuotaCall) Context(ctx context.Context) *ProjectsLocationsQueryContactCenterQuotaCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueryContactCenterQuotaCall) Do

func (c *ProjectsLocationsQueryContactCenterQuotaCall) Do(opts ...googleapi.CallOption) (*ContactCenterQuota, error)

Do executes the "contactcenteraiplatform.projects.locations.queryContactCenterQuota" call. Any non-2xx status code is an error. Response headers are in either *ContactCenterQuota.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueryContactCenterQuotaCall) Fields

func (c *ProjectsLocationsQueryContactCenterQuotaCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueryContactCenterQuotaCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsQueryContactCenterQuotaCall) Header

func (c *ProjectsLocationsQueryContactCenterQuotaCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsQueryContactCenterQuotaCall) IfNoneMatch

func (c *ProjectsLocationsQueryContactCenterQuotaCall) IfNoneMatch(entityTag string) *ProjectsLocationsQueryContactCenterQuotaCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsService

type ProjectsLocationsService struct {
    ContactCenters *ProjectsLocationsContactCentersService

    Operations *ProjectsLocationsOperationsService
    // contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get

func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List

func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

func (*ProjectsLocationsService) QueryContactCenterQuota

func (r *ProjectsLocationsService) QueryContactCenterQuota(parent string) *ProjectsLocationsQueryContactCenterQuotaCall

QueryContactCenterQuota: Queries the contact center quota, an aggregation over all the projects, that belongs to the billing account, which the input project belongs to.

- parent: Parent project resource id.

type ProjectsService

type ProjectsService struct {
    Locations *ProjectsLocationsService
    // contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Quota

Quota: Quota details.

type Quota struct {
    // ContactCenterCountLimit: Reflects the count limit of contact centers on a
    // billing account.
    ContactCenterCountLimit int64 `json:"contactCenterCountLimit,omitempty"`
    // ContactCenterCountSum: Reflects the count sum of contact centers on a
    // billing account.
    ContactCenterCountSum int64 `json:"contactCenterCountSum,omitempty"`
    // ContactCenterInstanceSize: Contact center instance type.
    //
    // Possible values:
    //   "INSTANCE_SIZE_UNSPECIFIED" - The default value. This value is used if the
    // state is omitted.
    //   "STANDARD_SMALL" - Instance Size STANDARD_SMALL.
    //   "STANDARD_MEDIUM" - Instance Size STANDARD_MEDIUM.
    //   "STANDARD_LARGE" - Instance Size STANDARD_LARGE.
    //   "STANDARD_XLARGE" - Instance Size STANDARD_XLARGE.
    //   "STANDARD_2XLARGE" - Instance Size STANDARD_2XLARGE.
    //   "STANDARD_3XLARGE" - Instance Size STANDARD_3XLARGE.
    //   "DEV_XSMALL" - Instance Size DEV_EXTRA_SMALL.
    //   "MULTIREGION_SMALL" - Instance Size MULTIREGION_SMALL
    //   "MULTIREGION_MEDIUM" - Instance Size MULTIREGION_MEDIUM
    //   "MULTIREGION_LARGE" - Instance Size MULTIREGION_LARGE
    //   "MULTIREGION_XLARGE" - Instance Size MULTIREGION_XLARGE
    //   "MULTIREGION_2XLARGE" - Instance Size MULTIREGION_2XLARGE.
    //   "MULTIREGION_3XLARGE" - Instance Size MULTIREGION_3XLARGE.
    ContactCenterInstanceSize string `json:"contactCenterInstanceSize,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ContactCenterCountLimit") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ContactCenterCountLimit") to
    // include in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Quota) MarshalJSON

func (s *Quota) MarshalJSON() ([]byte, error)

type SAMLParams

SAMLParams: Message storing SAML params to enable Google as IDP.

type SAMLParams struct {
    // Certificate: SAML certificate
    Certificate string `json:"certificate,omitempty"`
    // EmailMapping: IdP field that maps to the user’s email address
    EmailMapping string `json:"emailMapping,omitempty"`
    // EntityId: Entity id URL
    EntityId string `json:"entityId,omitempty"`
    // SsoUri: Single sign-on URL
    SsoUri string `json:"ssoUri,omitempty"`
    // UserEmail: Email address of the first admin users.
    UserEmail string `json:"userEmail,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Certificate") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Certificate") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*SAMLParams) MarshalJSON

func (s *SAMLParams) MarshalJSON() ([]byte, error)

type Service

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    Projects *ProjectsService
    // contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Status

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

type Status struct {
    // Code: The status code, which should be an enum value of google.rpc.Code.
    Code int64 `json:"code,omitempty"`
    // Details: A list of messages that carry the error details. There is a common
    // set of message types for APIs to use.
    Details []googleapi.RawMessage `json:"details,omitempty"`
    // Message: A developer-facing error message, which should be in English. Any
    // user-facing error message should be localized and sent in the
    // google.rpc.Status.details field, or localized by the client.
    Message string `json:"message,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Code") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Code") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Status) MarshalJSON

func (s *Status) MarshalJSON() ([]byte, error)

type URIs

URIs: Message storing the URIs of the ContactCenter.

type URIs struct {
    // ChatBotUri: Chat Bot Uri of the ContactCenter
    ChatBotUri string `json:"chatBotUri,omitempty"`
    // MediaUri: Media Uri of the ContactCenter.
    MediaUri string `json:"mediaUri,omitempty"`
    // RootUri: Root Uri of the ContactCenter.
    RootUri string `json:"rootUri,omitempty"`
    // VirtualAgentStreamingServiceUri: Virtual Agent Streaming Service Uri of the
    // ContactCenter.
    VirtualAgentStreamingServiceUri string `json:"virtualAgentStreamingServiceUri,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ChatBotUri") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ChatBotUri") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*URIs) MarshalJSON

func (s *URIs) MarshalJSON() ([]byte, error)