Documentation
¶
Overview ¶
Package discoveryengine provides access to the Discovery Engine API.
For product documentation, see: https://cloud.google.com/discovery-engine/docs
Creating a client ¶
Usage example:
import "google.golang.org/api/discoveryengine/v1beta" ... ctx := context.Background() discoveryengineService, err := discoveryengine.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 option.WithAPIKey:
discoveryengineService, err := discoveryengine.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) discoveryengineService, err := discoveryengine.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type GoogleApiHttpBody
- type GoogleCloudDiscoveryengineLoggingErrorContext
- type GoogleCloudDiscoveryengineLoggingErrorLog
- type GoogleCloudDiscoveryengineLoggingHttpRequestContext
- type GoogleCloudDiscoveryengineLoggingImportErrorContext
- type GoogleCloudDiscoveryengineLoggingServiceContext
- type GoogleCloudDiscoveryengineLoggingSourceLocation
- type GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
- type GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse
- type GoogleCloudDiscoveryengineV1alphaImportErrorConfig
- type GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata
- type GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse
- type GoogleCloudDiscoveryengineV1betaBigQuerySource
- type GoogleCloudDiscoveryengineV1betaCompletionInfo
- type GoogleCloudDiscoveryengineV1betaCustomAttribute
- type GoogleCloudDiscoveryengineV1betaDocument
- type GoogleCloudDiscoveryengineV1betaDocumentInfo
- type GoogleCloudDiscoveryengineV1betaGcsSource
- type GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata
- type GoogleCloudDiscoveryengineV1betaImportDocumentsRequest
- type GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource
- type GoogleCloudDiscoveryengineV1betaImportDocumentsResponse
- type GoogleCloudDiscoveryengineV1betaImportErrorConfig
- type GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata
- type GoogleCloudDiscoveryengineV1betaImportUserEventsRequest
- type GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource
- type GoogleCloudDiscoveryengineV1betaImportUserEventsResponse
- type GoogleCloudDiscoveryengineV1betaListDocumentsResponse
- type GoogleCloudDiscoveryengineV1betaMediaInfo
- type GoogleCloudDiscoveryengineV1betaPageInfo
- type GoogleCloudDiscoveryengineV1betaPanelInfo
- type GoogleCloudDiscoveryengineV1betaRecommendRequest
- type GoogleCloudDiscoveryengineV1betaRecommendResponse
- type GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult
- type GoogleCloudDiscoveryengineV1betaSearchInfo
- type GoogleCloudDiscoveryengineV1betaTransactionInfo
- type GoogleCloudDiscoveryengineV1betaUserEvent
- type GoogleCloudDiscoveryengineV1betaUserInfo
- type GoogleLongrunningListOperationsResponse
- type GoogleLongrunningOperation
- type GoogleProtobufEmpty
- type GoogleRpcStatus
- type GoogleTypeDate
- type ProjectsLocationsDataStoresBranchesDocumentsCreateCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsCreateCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaDocument, error)
- func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) DocumentId(documentId string) *ProjectsLocationsDataStoresBranchesDocumentsCreateCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsCreateCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Header() http.Header
- type ProjectsLocationsDataStoresBranchesDocumentsDeleteCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
- func (c *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Header() http.Header
- type ProjectsLocationsDataStoresBranchesDocumentsGetCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsGetCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaDocument, error)
- func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsGetCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) Header() http.Header
- func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresBranchesDocumentsGetCall
- type ProjectsLocationsDataStoresBranchesDocumentsImportCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsImportCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsImportCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsImportCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsDataStoresBranchesDocumentsImportCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsImportCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsImportCall) Header() http.Header
- type ProjectsLocationsDataStoresBranchesDocumentsListCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsListCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaListDocumentsResponse, error)
- func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsListCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Header() http.Header
- func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresBranchesDocumentsListCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) PageSize(pageSize int64) *ProjectsLocationsDataStoresBranchesDocumentsListCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) PageToken(pageToken string) *ProjectsLocationsDataStoresBranchesDocumentsListCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Pages(ctx context.Context, ...) error
- type ProjectsLocationsDataStoresBranchesDocumentsPatchCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsPatchCall) AllowMissing(allowMissing bool) *ProjectsLocationsDataStoresBranchesDocumentsPatchCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsPatchCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaDocument, error)
- func (c *ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsPatchCall
- func (c *ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Header() http.Header
- type ProjectsLocationsDataStoresBranchesDocumentsService
- func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Create(parent string, ...) *ProjectsLocationsDataStoresBranchesDocumentsCreateCall
- func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Delete(name string) *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall
- func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Get(name string) *ProjectsLocationsDataStoresBranchesDocumentsGetCall
- func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Import(parent string, ...) *ProjectsLocationsDataStoresBranchesDocumentsImportCall
- func (r *ProjectsLocationsDataStoresBranchesDocumentsService) List(parent string) *ProjectsLocationsDataStoresBranchesDocumentsListCall
- func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Patch(name string, ...) *ProjectsLocationsDataStoresBranchesDocumentsPatchCall
- type ProjectsLocationsDataStoresBranchesOperationsGetCall
- func (c *ProjectsLocationsDataStoresBranchesOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesOperationsGetCall
- func (c *ProjectsLocationsDataStoresBranchesOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsDataStoresBranchesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesOperationsGetCall
- func (c *ProjectsLocationsDataStoresBranchesOperationsGetCall) Header() http.Header
- func (c *ProjectsLocationsDataStoresBranchesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresBranchesOperationsGetCall
- type ProjectsLocationsDataStoresBranchesOperationsListCall
- func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesOperationsListCall
- func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
- func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesOperationsListCall
- func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Filter(filter string) *ProjectsLocationsDataStoresBranchesOperationsListCall
- func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Header() http.Header
- func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresBranchesOperationsListCall
- func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsDataStoresBranchesOperationsListCall
- func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) PageToken(pageToken string) *ProjectsLocationsDataStoresBranchesOperationsListCall
- func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
- type ProjectsLocationsDataStoresBranchesOperationsService
- type ProjectsLocationsDataStoresBranchesService
- type ProjectsLocationsDataStoresModelsOperationsGetCall
- func (c *ProjectsLocationsDataStoresModelsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsDataStoresModelsOperationsGetCall
- func (c *ProjectsLocationsDataStoresModelsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsDataStoresModelsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresModelsOperationsGetCall
- func (c *ProjectsLocationsDataStoresModelsOperationsGetCall) Header() http.Header
- func (c *ProjectsLocationsDataStoresModelsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresModelsOperationsGetCall
- type ProjectsLocationsDataStoresModelsOperationsListCall
- func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsDataStoresModelsOperationsListCall
- func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
- func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresModelsOperationsListCall
- func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Filter(filter string) *ProjectsLocationsDataStoresModelsOperationsListCall
- func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Header() http.Header
- func (c *ProjectsLocationsDataStoresModelsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresModelsOperationsListCall
- func (c *ProjectsLocationsDataStoresModelsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsDataStoresModelsOperationsListCall
- func (c *ProjectsLocationsDataStoresModelsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsDataStoresModelsOperationsListCall
- func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
- type ProjectsLocationsDataStoresModelsOperationsService
- type ProjectsLocationsDataStoresModelsService
- type ProjectsLocationsDataStoresOperationsGetCall
- func (c *ProjectsLocationsDataStoresOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsDataStoresOperationsGetCall
- func (c *ProjectsLocationsDataStoresOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsDataStoresOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresOperationsGetCall
- func (c *ProjectsLocationsDataStoresOperationsGetCall) Header() http.Header
- func (c *ProjectsLocationsDataStoresOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresOperationsGetCall
- type ProjectsLocationsDataStoresOperationsListCall
- func (c *ProjectsLocationsDataStoresOperationsListCall) Context(ctx context.Context) *ProjectsLocationsDataStoresOperationsListCall
- func (c *ProjectsLocationsDataStoresOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
- func (c *ProjectsLocationsDataStoresOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresOperationsListCall
- func (c *ProjectsLocationsDataStoresOperationsListCall) Filter(filter string) *ProjectsLocationsDataStoresOperationsListCall
- func (c *ProjectsLocationsDataStoresOperationsListCall) Header() http.Header
- func (c *ProjectsLocationsDataStoresOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresOperationsListCall
- func (c *ProjectsLocationsDataStoresOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsDataStoresOperationsListCall
- func (c *ProjectsLocationsDataStoresOperationsListCall) PageToken(pageToken string) *ProjectsLocationsDataStoresOperationsListCall
- func (c *ProjectsLocationsDataStoresOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
- type ProjectsLocationsDataStoresOperationsService
- type ProjectsLocationsDataStoresService
- type ProjectsLocationsDataStoresServingConfigsRecommendCall
- func (c *ProjectsLocationsDataStoresServingConfigsRecommendCall) Context(ctx context.Context) *ProjectsLocationsDataStoresServingConfigsRecommendCall
- func (c *ProjectsLocationsDataStoresServingConfigsRecommendCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaRecommendResponse, error)
- func (c *ProjectsLocationsDataStoresServingConfigsRecommendCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresServingConfigsRecommendCall
- func (c *ProjectsLocationsDataStoresServingConfigsRecommendCall) Header() http.Header
- type ProjectsLocationsDataStoresServingConfigsService
- type ProjectsLocationsDataStoresUserEventsCollectCall
- func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Context(ctx context.Context) *ProjectsLocationsDataStoresUserEventsCollectCall
- func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Do(opts ...googleapi.CallOption) (*GoogleApiHttpBody, error)
- func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Ets(ets int64) *ProjectsLocationsDataStoresUserEventsCollectCall
- func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresUserEventsCollectCall
- func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Header() http.Header
- func (c *ProjectsLocationsDataStoresUserEventsCollectCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresUserEventsCollectCall
- func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Uri(uri string) *ProjectsLocationsDataStoresUserEventsCollectCall
- func (c *ProjectsLocationsDataStoresUserEventsCollectCall) UserEvent(userEvent string) *ProjectsLocationsDataStoresUserEventsCollectCall
- type ProjectsLocationsDataStoresUserEventsImportCall
- func (c *ProjectsLocationsDataStoresUserEventsImportCall) Context(ctx context.Context) *ProjectsLocationsDataStoresUserEventsImportCall
- func (c *ProjectsLocationsDataStoresUserEventsImportCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsDataStoresUserEventsImportCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresUserEventsImportCall
- func (c *ProjectsLocationsDataStoresUserEventsImportCall) Header() http.Header
- type ProjectsLocationsDataStoresUserEventsService
- func (r *ProjectsLocationsDataStoresUserEventsService) Collect(parent string) *ProjectsLocationsDataStoresUserEventsCollectCall
- func (r *ProjectsLocationsDataStoresUserEventsService) Import(parent string, ...) *ProjectsLocationsDataStoresUserEventsImportCall
- func (r *ProjectsLocationsDataStoresUserEventsService) Write(parent string, ...) *ProjectsLocationsDataStoresUserEventsWriteCall
- type ProjectsLocationsDataStoresUserEventsWriteCall
- func (c *ProjectsLocationsDataStoresUserEventsWriteCall) Context(ctx context.Context) *ProjectsLocationsDataStoresUserEventsWriteCall
- func (c *ProjectsLocationsDataStoresUserEventsWriteCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaUserEvent, error)
- func (c *ProjectsLocationsDataStoresUserEventsWriteCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresUserEventsWriteCall
- func (c *ProjectsLocationsDataStoresUserEventsWriteCall) Header() http.Header
- type ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, 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) (*GoogleLongrunningListOperationsResponse, 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(*GoogleLongrunningListOperationsResponse) error) error
- type ProjectsLocationsOperationsService
- type ProjectsLocationsService
- type ProjectsOperationsGetCall
- func (c *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall
- func (c *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall
- func (c *ProjectsOperationsGetCall) Header() http.Header
- func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall
- type ProjectsOperationsListCall
- func (c *ProjectsOperationsListCall) Context(ctx context.Context) *ProjectsOperationsListCall
- func (c *ProjectsOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
- func (c *ProjectsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsOperationsListCall
- func (c *ProjectsOperationsListCall) Filter(filter string) *ProjectsOperationsListCall
- func (c *ProjectsOperationsListCall) Header() http.Header
- func (c *ProjectsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsOperationsListCall
- func (c *ProjectsOperationsListCall) PageSize(pageSize int64) *ProjectsOperationsListCall
- func (c *ProjectsOperationsListCall) PageToken(pageToken string) *ProjectsOperationsListCall
- func (c *ProjectsOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
- type ProjectsOperationsService
- type ProjectsService
- type Service
Constants ¶
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" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GoogleApiHttpBody ¶
type GoogleApiHttpBody struct { // ContentType: The HTTP Content-Type header value specifying the // content type of the body. ContentType string `json:"contentType,omitempty"` // Data: The HTTP request/response body as raw binary. Data string `json:"data,omitempty"` // Extensions: Application specific response metadata. Must be set in // the first response for streaming APIs. Extensions []googleapi.RawMessage `json:"extensions,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ContentType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ContentType") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleApiHttpBody: Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
func (*GoogleApiHttpBody) MarshalJSON ¶
func (s *GoogleApiHttpBody) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineLoggingErrorContext ¶ added in v0.107.0
type GoogleCloudDiscoveryengineLoggingErrorContext struct { // HttpRequest: The HTTP request which was processed when the error was // triggered. HttpRequest *GoogleCloudDiscoveryengineLoggingHttpRequestContext `json:"httpRequest,omitempty"` // ReportLocation: The location in the source code where the decision // was made to report the error, usually the place where it was logged. ReportLocation *GoogleCloudDiscoveryengineLoggingSourceLocation `json:"reportLocation,omitempty"` // ForceSendFields is a list of field names (e.g. "HttpRequest") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "HttpRequest") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineLoggingErrorContext: A description of the context in which an error occurred.
func (*GoogleCloudDiscoveryengineLoggingErrorContext) MarshalJSON ¶ added in v0.107.0
func (s *GoogleCloudDiscoveryengineLoggingErrorContext) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineLoggingErrorLog ¶ added in v0.107.0
type GoogleCloudDiscoveryengineLoggingErrorLog struct { // Context: A description of the context in which the error occurred. Context *GoogleCloudDiscoveryengineLoggingErrorContext `json:"context,omitempty"` // ImportPayload: The error payload that is populated on LRO import // APIs. ImportPayload *GoogleCloudDiscoveryengineLoggingImportErrorContext `json:"importPayload,omitempty"` // Message: A message describing the error. Message string `json:"message,omitempty"` // RequestPayload: The API request payload, represented as a protocol // buffer. Most API request types are supported. For example: // "type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentServ // ice.CreateDocumentRequest" // "type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventSer // vice.WriteUserEventRequest" RequestPayload googleapi.RawMessage `json:"requestPayload,omitempty"` // ResponsePayload: The API response payload, represented as a protocol // buffer. This is used to log some "soft errors", where the response is // valid but we consider there are some quality issues like unjoined // events. The following API responses are supported and no PII is // included: // "google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend" // // "google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent" // // "google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEven // t" ResponsePayload googleapi.RawMessage `json:"responsePayload,omitempty"` // ServiceContext: The service context in which this error has occurred. ServiceContext *GoogleCloudDiscoveryengineLoggingServiceContext `json:"serviceContext,omitempty"` // Status: The RPC status associated with the error log. Status *GoogleRpcStatus `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "Context") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Context") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineLoggingErrorLog: An error log which is reported to the Error Reporting system.
func (*GoogleCloudDiscoveryengineLoggingErrorLog) MarshalJSON ¶ added in v0.107.0
func (s *GoogleCloudDiscoveryengineLoggingErrorLog) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineLoggingHttpRequestContext ¶ added in v0.107.0
type GoogleCloudDiscoveryengineLoggingHttpRequestContext struct { // ResponseStatusCode: The HTTP response status code for the request. ResponseStatusCode int64 `json:"responseStatusCode,omitempty"` // ForceSendFields is a list of field names (e.g. "ResponseStatusCode") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ResponseStatusCode") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineLoggingHttpRequestContext: HTTP request data that is related to a reported error.
func (*GoogleCloudDiscoveryengineLoggingHttpRequestContext) MarshalJSON ¶ added in v0.107.0
func (s *GoogleCloudDiscoveryengineLoggingHttpRequestContext) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineLoggingImportErrorContext ¶ added in v0.107.0
type GoogleCloudDiscoveryengineLoggingImportErrorContext struct { // Document: The detailed content which caused the error on importing a // document. Document string `json:"document,omitempty"` // GcsPath: Google Cloud Storage file path of the import source. Can be // set for batch operation error. GcsPath string `json:"gcsPath,omitempty"` // LineNumber: Line number of the content in file. Should be empty for // permission or batch operation error. LineNumber string `json:"lineNumber,omitempty"` // Operation: The operation resource name of the LRO. Operation string `json:"operation,omitempty"` // UserEvent: The detailed content which caused the error on importing a // user event. UserEvent string `json:"userEvent,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Document") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineLoggingImportErrorContext: The error payload that is populated on LRO import APIs. Including: "google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments"
"google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvent s"
func (*GoogleCloudDiscoveryengineLoggingImportErrorContext) MarshalJSON ¶ added in v0.107.0
func (s *GoogleCloudDiscoveryengineLoggingImportErrorContext) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineLoggingServiceContext ¶ added in v0.107.0
type GoogleCloudDiscoveryengineLoggingServiceContext struct { // Service: An identifier of the service. For example, // "discoveryengine.googleapis.com". Service string `json:"service,omitempty"` // ForceSendFields is a list of field names (e.g. "Service") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Service") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineLoggingServiceContext: Describes a running service that sends errors.
func (*GoogleCloudDiscoveryengineLoggingServiceContext) MarshalJSON ¶ added in v0.107.0
func (s *GoogleCloudDiscoveryengineLoggingServiceContext) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineLoggingSourceLocation ¶ added in v0.107.0
type GoogleCloudDiscoveryengineLoggingSourceLocation struct { // FunctionName: Human-readable name of a function or method. For // example, " // google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend". FunctionName string `json:"functionName,omitempty"` // ForceSendFields is a list of field names (e.g. "FunctionName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FunctionName") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineLoggingSourceLocation: Indicates a location in the source code of the service for which errors are reported.
func (*GoogleCloudDiscoveryengineLoggingSourceLocation) MarshalJSON ¶ added in v0.107.0
func (s *GoogleCloudDiscoveryengineLoggingSourceLocation) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata ¶
type GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` // FailureCount: Count of entries that encountered errors while // processing. FailureCount int64 `json:"failureCount,omitempty,string"` // SuccessCount: Count of entries that were processed successfully. SuccessCount int64 `json:"successCount,omitempty,string"` // UpdateTime: Operation last update time. If the operation is done, // this is also the finish time. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreateTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata: Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse ¶
type GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse struct { // ErrorConfig: Echoes the destination for the complete errors in the // request if set. ErrorConfig *GoogleCloudDiscoveryengineV1alphaImportErrorConfig `json:"errorConfig,omitempty"` // ErrorSamples: A sample of errors encountered while processing the // request. ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` // ForceSendFields is a list of field names (e.g. "ErrorConfig") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ErrorConfig") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse: Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
func (*GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1alphaImportErrorConfig ¶
type GoogleCloudDiscoveryengineV1alphaImportErrorConfig struct { // GcsPrefix: Cloud Storage prefix for import errors. This must be an // empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsPrefix") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "GcsPrefix") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1alphaImportErrorConfig: Configuration of destination for Import related errors.
func (*GoogleCloudDiscoveryengineV1alphaImportErrorConfig) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1alphaImportErrorConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata ¶
type GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` // FailureCount: Count of entries that encountered errors while // processing. FailureCount int64 `json:"failureCount,omitempty,string"` // SuccessCount: Count of entries that were processed successfully. SuccessCount int64 `json:"successCount,omitempty,string"` // UpdateTime: Operation last update time. If the operation is done, // this is also the finish time. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreateTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata: Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse ¶
type GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse struct { // ErrorConfig: Echoes the destination for the complete errors if this // field was set in the request. ErrorConfig *GoogleCloudDiscoveryengineV1alphaImportErrorConfig `json:"errorConfig,omitempty"` // ErrorSamples: A sample of errors encountered while processing the // request. ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` // JoinedEventsCount: Count of user events imported with complete // existing Documents. JoinedEventsCount int64 `json:"joinedEventsCount,omitempty,string"` // UnjoinedEventsCount: Count of user events imported, but with Document // information not found in the existing Branch. UnjoinedEventsCount int64 `json:"unjoinedEventsCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ErrorConfig") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ErrorConfig") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse: Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
func (*GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaBigQuerySource ¶
type GoogleCloudDiscoveryengineV1betaBigQuerySource struct { // DataSchema: The schema to use when parsing the data from the source. // Supported values for imports: * `user_event` (default): One JSON // UserEvent per line. * `document` (default): One JSON Document per // line. Each document must have a valid document.id. DataSchema string `json:"dataSchema,omitempty"` // DatasetId: Required. The BigQuery data set to copy the data from with // a length limit of 1,024 characters. DatasetId string `json:"datasetId,omitempty"` // GcsStagingDir: Intermediate Cloud Storage directory used for the // import with a length limit of 2,000 characters. Can be specified if // one wants to have the BigQuery export to a specific Cloud Storage // directory. GcsStagingDir string `json:"gcsStagingDir,omitempty"` // PartitionDate: BigQuery time partitioned table's _PARTITIONDATE in // YYYY-MM-DD format. PartitionDate *GoogleTypeDate `json:"partitionDate,omitempty"` // ProjectId: The project ID (can be project # or ID) that the BigQuery // source is in with a length limit of 128 characters. If not specified, // inherits the project ID from the parent request. ProjectId string `json:"projectId,omitempty"` // TableId: Required. The BigQuery table to copy the data from with a // length limit of 1,024 characters. TableId string `json:"tableId,omitempty"` // ForceSendFields is a list of field names (e.g. "DataSchema") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataSchema") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaBigQuerySource: BigQuery source import data from.
func (*GoogleCloudDiscoveryengineV1betaBigQuerySource) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaBigQuerySource) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaCompletionInfo ¶
type GoogleCloudDiscoveryengineV1betaCompletionInfo struct { // SelectedPosition: End user selected // CompleteQueryResponse.CompletionResult.suggestion position, starting // from 0. SelectedPosition int64 `json:"selectedPosition,omitempty"` // SelectedSuggestion: End user selected // CompleteQueryResponse.CompletionResult.suggestion. SelectedSuggestion string `json:"selectedSuggestion,omitempty"` // ForceSendFields is a list of field names (e.g. "SelectedPosition") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "SelectedPosition") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaCompletionInfo: Detailed completion information including completion attribution token and clicked completion info.
func (*GoogleCloudDiscoveryengineV1betaCompletionInfo) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaCompletionInfo) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaCustomAttribute ¶
type GoogleCloudDiscoveryengineV1betaCustomAttribute struct { // Numbers: The numerical values of this custom attribute. For example, // `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or // numbers should be set. Otherwise, an INVALID_ARGUMENT error is // returned. Numbers []float64 `json:"numbers,omitempty"` // Text: The textual values of this custom attribute. For example, // `["yellow", "green"]` when the key is "color". Empty string is not // allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly // one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT // error is returned. Text []string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "Numbers") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Numbers") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaCustomAttribute: A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
func (*GoogleCloudDiscoveryengineV1betaCustomAttribute) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaCustomAttribute) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaDocument ¶
type GoogleCloudDiscoveryengineV1betaDocument struct { // Id: Immutable. The identifier of the document. Id should conform to // RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length // limit of 63 characters. Id string `json:"id,omitempty"` // JsonData: The JSON string representation of the document. It should // conform to the registered schema or an INVALID_ARGUMENT error is // thrown. JsonData string `json:"jsonData,omitempty"` // Name: Immutable. The full resource name of the document. Format: // `projects/{project}/locations/{location}/dataStores/{data_store}/branc // hes/{branch}/documents/{document_id}`. This field must be a UTF-8 // encoded string with a length limit of 1024 characters. Name string `json:"name,omitempty"` // ParentDocumentId: The identifier of the parent document. Currently // supports at most two level document hierarchy. Id should conform to // RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length // limit of 63 characters. ParentDocumentId string `json:"parentDocumentId,omitempty"` // SchemaId: Required. The identifier of the schema located in the same // data store. SchemaId string `json:"schemaId,omitempty"` // StructData: The structured JSON data for the document. It should // conform to the registered schema or an INVALID_ARGUMENT error is // thrown. StructData googleapi.RawMessage `json:"structData,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Id") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaDocument: Document captures all raw metadata information of items to be recommended or searched.
func (*GoogleCloudDiscoveryengineV1betaDocument) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaDocument) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaDocumentInfo ¶
type GoogleCloudDiscoveryengineV1betaDocumentInfo struct { // Id: Required. The Document resource ID. Id string `json:"id,omitempty"` // Name: Required. The Document resource full name, of the form: // projects//locations//dataStores//branches//documents/ Name string `json:"name,omitempty"` // PromotionIds: The promotion IDs associated with this Document. // Currently, this field is restricted to at most one ID. PromotionIds []string `json:"promotionIds,omitempty"` // Quantity: Quantity of the Document associated with the user event. // Defaults to 1. For example, this field will be 2 if two quantities of // the same Document are involved in a `add-to-cart` event. Required for // events of the following event types: * `add-to-cart` * `purchase` Quantity int64 `json:"quantity,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Id") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaDocumentInfo: Detailed document information associated with a user event.
func (*GoogleCloudDiscoveryengineV1betaDocumentInfo) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaDocumentInfo) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaGcsSource ¶
type GoogleCloudDiscoveryengineV1betaGcsSource struct { // DataSchema: The schema to use when parsing the data from the source. // Supported values for imports: * `user_event` (default): One JSON // UserEvent per line. * `document` (default): One JSON Document per // line. Each document must have a valid Document.id. DataSchema string `json:"dataSchema,omitempty"` // InputUris: Required. Cloud Storage URIs to input files. URI can be up // to 2000 characters long. URIs can match the full object path (for // example, `gs://bucket/directory/object.json`) or a pattern matching // one or more files, such as `gs://bucket/directory/*.json`. A request // can contain at most 100 files, and each file can be up to 2 GB. InputUris []string `json:"inputUris,omitempty"` // ForceSendFields is a list of field names (e.g. "DataSchema") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataSchema") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaGcsSource: Cloud Storage location for input content.
func (*GoogleCloudDiscoveryengineV1betaGcsSource) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaGcsSource) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata ¶
type GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` // FailureCount: Count of entries that encountered errors while // processing. FailureCount int64 `json:"failureCount,omitempty,string"` // SuccessCount: Count of entries that were processed successfully. SuccessCount int64 `json:"successCount,omitempty,string"` // UpdateTime: Operation last update time. If the operation is done, // this is also the finish time. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreateTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata: Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaImportDocumentsRequest ¶
type GoogleCloudDiscoveryengineV1betaImportDocumentsRequest struct { // BigquerySource: BigQuery input source. BigquerySource *GoogleCloudDiscoveryengineV1betaBigQuerySource `json:"bigquerySource,omitempty"` // ErrorConfig: The desired location of errors incurred during the // Import. ErrorConfig *GoogleCloudDiscoveryengineV1betaImportErrorConfig `json:"errorConfig,omitempty"` // GcsSource: Cloud Storage location for the input content. GcsSource *GoogleCloudDiscoveryengineV1betaGcsSource `json:"gcsSource,omitempty"` // InlineSource: The Inline source for the input content for documents. InlineSource *GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource `json:"inlineSource,omitempty"` // ReconciliationMode: The mode of reconciliation between existing // documents and the documents to be imported. Defaults to // ReconciliationMode.INCREMENTAL. // // Possible values: // "RECONCILIATION_MODE_UNSPECIFIED" - Defaults to INCREMENTAL. // "INCREMENTAL" - Inserts new documents or updates existing // documents. // "FULL" - Calculates diff and replaces the entire document dataset. // Existing documents may be deleted if they are not present in the // source location. ReconciliationMode string `json:"reconciliationMode,omitempty"` // ForceSendFields is a list of field names (e.g. "BigquerySource") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BigquerySource") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaImportDocumentsRequest: Request message for Import methods.
func (*GoogleCloudDiscoveryengineV1betaImportDocumentsRequest) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaImportDocumentsRequest) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource ¶
type GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource struct { // Documents: Required. A list of documents to update/create. Each // document must have a valid Document.id. Recommended max of 100 items. Documents []*GoogleCloudDiscoveryengineV1betaDocument `json:"documents,omitempty"` // ForceSendFields is a list of field names (e.g. "Documents") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Documents") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource: The inline source for the input config for ImportDocuments method.
func (*GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaImportDocumentsResponse ¶
type GoogleCloudDiscoveryengineV1betaImportDocumentsResponse struct { // ErrorConfig: Echoes the destination for the complete errors in the // request if set. ErrorConfig *GoogleCloudDiscoveryengineV1betaImportErrorConfig `json:"errorConfig,omitempty"` // ErrorSamples: A sample of errors encountered while processing the // request. ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` // ForceSendFields is a list of field names (e.g. "ErrorConfig") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ErrorConfig") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaImportDocumentsResponse: Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
func (*GoogleCloudDiscoveryengineV1betaImportDocumentsResponse) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaImportDocumentsResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaImportErrorConfig ¶
type GoogleCloudDiscoveryengineV1betaImportErrorConfig struct { // GcsPrefix: Cloud Storage prefix for import errors. This must be an // empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsPrefix") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "GcsPrefix") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaImportErrorConfig: Configuration of destination for Import related errors.
func (*GoogleCloudDiscoveryengineV1betaImportErrorConfig) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaImportErrorConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata ¶
type GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` // FailureCount: Count of entries that encountered errors while // processing. FailureCount int64 `json:"failureCount,omitempty,string"` // SuccessCount: Count of entries that were processed successfully. SuccessCount int64 `json:"successCount,omitempty,string"` // UpdateTime: Operation last update time. If the operation is done, // this is also the finish time. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreateTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata: Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaImportUserEventsRequest ¶
type GoogleCloudDiscoveryengineV1betaImportUserEventsRequest struct { // BigquerySource: Required. BigQuery input source. BigquerySource *GoogleCloudDiscoveryengineV1betaBigQuerySource `json:"bigquerySource,omitempty"` // ErrorConfig: The desired location of errors incurred during the // Import. Cannot be set for inline user event imports. ErrorConfig *GoogleCloudDiscoveryengineV1betaImportErrorConfig `json:"errorConfig,omitempty"` // GcsSource: Required. Cloud Storage location for the input content. GcsSource *GoogleCloudDiscoveryengineV1betaGcsSource `json:"gcsSource,omitempty"` // InlineSource: Required. The Inline source for the input content for // UserEvents. InlineSource *GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource `json:"inlineSource,omitempty"` // ForceSendFields is a list of field names (e.g. "BigquerySource") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BigquerySource") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaImportUserEventsRequest: Request message for the ImportUserEvents request.
func (*GoogleCloudDiscoveryengineV1betaImportUserEventsRequest) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaImportUserEventsRequest) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource ¶
type GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource struct { // UserEvents: Required. A list of user events to import. Recommended // max of 10k items. UserEvents []*GoogleCloudDiscoveryengineV1betaUserEvent `json:"userEvents,omitempty"` // ForceSendFields is a list of field names (e.g. "UserEvents") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "UserEvents") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource: The inline source for the input config for ImportUserEvents method.
func (*GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaImportUserEventsResponse ¶
type GoogleCloudDiscoveryengineV1betaImportUserEventsResponse struct { // ErrorConfig: Echoes the destination for the complete errors if this // field was set in the request. ErrorConfig *GoogleCloudDiscoveryengineV1betaImportErrorConfig `json:"errorConfig,omitempty"` // ErrorSamples: A sample of errors encountered while processing the // request. ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` // JoinedEventsCount: Count of user events imported with complete // existing Documents. JoinedEventsCount int64 `json:"joinedEventsCount,omitempty,string"` // UnjoinedEventsCount: Count of user events imported, but with Document // information not found in the existing Branch. UnjoinedEventsCount int64 `json:"unjoinedEventsCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ErrorConfig") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ErrorConfig") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaImportUserEventsResponse: Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
func (*GoogleCloudDiscoveryengineV1betaImportUserEventsResponse) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaImportUserEventsResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaListDocumentsResponse ¶
type GoogleCloudDiscoveryengineV1betaListDocumentsResponse struct { // Documents: The Documents. Documents []*GoogleCloudDiscoveryengineV1betaDocument `json:"documents,omitempty"` // NextPageToken: A token that can be sent as // ListDocumentsRequest.page_token to retrieve the next page. If this // field is omitted, there are no subsequent pages. 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. "Documents") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Documents") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaListDocumentsResponse: Response message for DocumentService.ListDocuments method.
func (*GoogleCloudDiscoveryengineV1betaListDocumentsResponse) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaListDocumentsResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaMediaInfo ¶
type GoogleCloudDiscoveryengineV1betaMediaInfo struct { // MediaProgressDuration: The media progress time in seconds, if // applicable. For example, if the end user has finished 90 seconds of a // playback video, then MediaInfo.media_progress_duration.seconds should // be set to 90. MediaProgressDuration string `json:"mediaProgressDuration,omitempty"` // MediaProgressPercentage: Media progress should be computed using only // the media_progress_duration relative to the media total length. This // value must be between [0, 1.0] inclusive. If this is not a playback // or the progress cannot be computed (e.g. ongoing livestream), this // field should be unset. MediaProgressPercentage float64 `json:"mediaProgressPercentage,omitempty"` // ForceSendFields is a list of field names (e.g. // "MediaProgressDuration") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "MediaProgressDuration") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaMediaInfo: Media-specific user event information.
func (*GoogleCloudDiscoveryengineV1betaMediaInfo) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaMediaInfo) MarshalJSON() ([]byte, error)
func (*GoogleCloudDiscoveryengineV1betaMediaInfo) UnmarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaMediaInfo) UnmarshalJSON(data []byte) error
type GoogleCloudDiscoveryengineV1betaPageInfo ¶
type GoogleCloudDiscoveryengineV1betaPageInfo struct { // PageCategory: The most specific category associated with a category // page. To represent full path of category, use '>' sign to separate // different hierarchies. If '>' is part of the category name, please // replace it with other character(s). Category pages include special // pages such as sales or promotions. For instance, a special sale page // may have the category hierarchy: "pageCategory" : "Sales > 2017 Black // Friday Deals". Required for `view-category-page` events. Other event // types should not set this field. Otherwise, an INVALID_ARGUMENT error // is returned. PageCategory string `json:"pageCategory,omitempty"` // PageviewId: A unique ID of a web page view. This should be kept the // same for all user events triggered from the same pageview. For // example, an item detail page view could trigger multiple events as // the user is browsing the page. The `pageViewId` property should be // kept the same for all these events so that they can be grouped // together properly. When using the client side event reporting with // JavaScript pixel and Google Tag Manager, this value is filled in // automatically. PageviewId string `json:"pageviewId,omitempty"` // ReferrerUri: The referrer URL of the current page. When using the // client side event reporting with JavaScript pixel and Google Tag // Manager, this value is filled in automatically. However, some browser // privacy restrictions may cause this field to be empty. ReferrerUri string `json:"referrerUri,omitempty"` // Uri: Complete URL (window.location.href) of the user's current page. // When using the client side event reporting with JavaScript pixel and // Google Tag Manager, this value is filled in automatically. Maximum // length 5,000 characters. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "PageCategory") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "PageCategory") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaPageInfo: Detailed page information.
func (*GoogleCloudDiscoveryengineV1betaPageInfo) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaPageInfo) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaPanelInfo ¶
type GoogleCloudDiscoveryengineV1betaPanelInfo struct { // DisplayName: The display name of the panel. DisplayName string `json:"displayName,omitempty"` // PanelId: Required. The panel ID. PanelId string `json:"panelId,omitempty"` // PanelPosition: The ordered position of the panel, if shown to the // user with other panels. If set, then total_panels must also be set. PanelPosition int64 `json:"panelPosition,omitempty"` // TotalPanels: The total number of panels, including this one, shown to // the user. Must be set if panel_position is set. TotalPanels int64 `json:"totalPanels,omitempty"` // 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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaPanelInfo: Detailed panel information associated with a user event.
func (*GoogleCloudDiscoveryengineV1betaPanelInfo) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaPanelInfo) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaRecommendRequest ¶
type GoogleCloudDiscoveryengineV1betaRecommendRequest struct { // Filter: Filter for restricting recommendation results with a length // limit of 5,000 characters. Currently, only filter expressions on the // `filter_tags` attribute is supported. Examples: * (filter_tags: // ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold")) * // (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green")) // If your filter blocks all results, the API will return generic // (unfiltered) popular Documents. If you only want results strictly // matching the filters, set `strictFiltering` to True in // RecommendRequest.params to receive empty results instead. Note that // the API will never return Documents with storageStatus of "EXPIRED" // or "DELETED" regardless of filter choices. Filter string `json:"filter,omitempty"` // PageSize: Maximum number of results to return. Set this property to // the number of recommendation results needed. If zero, the service // will choose a reasonable default. The maximum allowed value is 100. // Values above 100 will be coerced to 100. PageSize int64 `json:"pageSize,omitempty"` // Params: Additional domain specific parameters for the // recommendations. Allowed values: * `returnDocument`: Boolean. If set // to true, the associated Document object will be returned in // RecommendResponse.results.document. * `returnScore`: Boolean. If set // to true, the recommendation 'score' corresponding to each returned // Document will be set in RecommendResponse.results.metadata. The given // 'score' indicates the probability of a Document conversion given the // user's context and history. * `strictFiltering`: Boolean. True by // default. If set to false, the service will return generic // (unfiltered) popular Documents instead of empty if your filter blocks // all recommendation results. * `diversityLevel`: String. Default // empty. If set to be non-empty, then it needs to be one of: * // 'no-diversity' * 'low-diversity' * 'medium-diversity' * // 'high-diversity' * 'auto-diversity' This gives request-level control // and adjusts recommendation results based on Document category. Params googleapi.RawMessage `json:"params,omitempty"` // UserEvent: Required. Context about the user, what they are looking at // and what action they took to trigger the Recommend request. Note that // this user event detail won't be ingested to userEvent logs. Thus, a // separate userEvent write request is required for event logging. Don't // set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the // same fixed ID for different users. If you are trying to receive // non-personalized recommendations (not recommended; this can // negatively impact model performance), instead set // UserEvent.user_pseudo_id to a random unique ID and leave // UserEvent.user_info.user_id unset. UserEvent *GoogleCloudDiscoveryengineV1betaUserEvent `json:"userEvent,omitempty"` // UserLabels: The user labels applied to a resource must meet the // following requirements: * Each resource can have multiple labels, up // to a maximum of 64. * Each label must be a key-value pair. * Keys // have a minimum length of 1 character and a maximum length of 63 // characters and cannot be empty. Values can be empty and have a // maximum length of 63 characters. * Keys and values can contain only // lowercase letters, numeric characters, underscores, and dashes. All // characters must use UTF-8 encoding, and international characters are // allowed. * The key portion of a label must be unique. However, you // can use the same key with multiple resources. * Keys must start with // a lowercase letter or international character. See Requirements for // labels // (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) // for more details. UserLabels map[string]string `json:"userLabels,omitempty"` // ValidateOnly: Use validate only mode for this recommendation query. // If set to true, a fake model will be used that returns arbitrary // Document IDs. Note that the validate only mode should only be used // for testing the API, or if the model is not ready. ValidateOnly bool `json:"validateOnly,omitempty"` // ForceSendFields is a list of field names (e.g. "Filter") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Filter") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaRecommendRequest: Request message for Recommend method.
func (*GoogleCloudDiscoveryengineV1betaRecommendRequest) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaRecommendRequest) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaRecommendResponse ¶
type GoogleCloudDiscoveryengineV1betaRecommendResponse struct { // AttributionToken: A unique attribution token. This should be included // in the UserEvent logs resulting from this recommendation, which // enables accurate attribution of recommendation model performance. AttributionToken string `json:"attributionToken,omitempty"` // MissingIds: IDs of documents in the request that were missing from // the default Branch associated with the requested ServingConfig. MissingIds []string `json:"missingIds,omitempty"` // Results: A list of recommended Documents. The order represents the // ranking (from the most relevant Document to the least). Results []*GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult `json:"results,omitempty"` // ValidateOnly: True if RecommendRequest.validate_only was set. ValidateOnly bool `json:"validateOnly,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AttributionToken") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AttributionToken") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaRecommendResponse: Response message for Recommend method.
func (*GoogleCloudDiscoveryengineV1betaRecommendResponse) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaRecommendResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult ¶
type GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult struct { // Document: Set if `returnDocument` is set to true in // RecommendRequest.params. Document *GoogleCloudDiscoveryengineV1betaDocument `json:"document,omitempty"` // Id: Resource ID of the recommended Document. Id string `json:"id,omitempty"` // Metadata: Additional Document metadata / annotations. Possible // values: * `score`: Recommendation score in double value. Is set if // `returnScore` is set to true in RecommendRequest.params. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Document") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult:
RecommendationResult represents a generic recommendation result with
associated metadata.
func (*GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaSearchInfo ¶
type GoogleCloudDiscoveryengineV1betaSearchInfo struct { // Offset: An integer that specifies the current offset for pagination // (the 0-indexed starting location, amongst the products deemed by the // API as relevant). See SearchRequest.offset for definition. If this // field is negative, an INVALID_ARGUMENT is returned. This can only be // set for `search` events. Other event types should not set this field. // Otherwise, an INVALID_ARGUMENT error is returned. Offset int64 `json:"offset,omitempty"` // OrderBy: The order in which products are returned, if applicable. See // SearchRequest.order_by for definition and syntax. The value must be a // UTF-8 encoded string with a length limit of 1,000 characters. // Otherwise, an INVALID_ARGUMENT error is returned. This can only be // set for `search` events. Other event types should not set this field. // Otherwise, an INVALID_ARGUMENT error is returned. OrderBy string `json:"orderBy,omitempty"` // SearchQuery: The user's search query. See SearchRequest.query for // definition. The value must be a UTF-8 encoded string with a length // limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is // returned. At least one of search_query or page_categories is required // for `search` events. Other event types should not set this field. // Otherwise, an INVALID_ARGUMENT error is returned. SearchQuery string `json:"searchQuery,omitempty"` // ForceSendFields is a list of field names (e.g. "Offset") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Offset") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaSearchInfo: Detailed search information.
func (*GoogleCloudDiscoveryengineV1betaSearchInfo) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaSearchInfo) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaTransactionInfo ¶
type GoogleCloudDiscoveryengineV1betaTransactionInfo struct { // Cost: All the costs associated with the products. These can be // manufacturing costs, shipping expenses not borne by the end user, or // any other costs, such that: * Profit = value - tax - cost Cost float64 `json:"cost,omitempty"` // Currency: Required. Currency code. Use three-character ISO-4217 code. Currency string `json:"currency,omitempty"` // DiscountValue: The total discount(s) value applied to this // transaction. This figure should be excluded from // TransactionInfo.value For example, if a user paid // TransactionInfo.value amount, then nominal (pre-discount) value of // the transaction is the sum of TransactionInfo.value and // TransactionInfo.discount_value This means that profit is calculated // the same way, regardless of the discount value, and that // TransactionInfo.discount_value can be larger than // TransactionInfo.value: * Profit = value - tax - cost DiscountValue float64 `json:"discountValue,omitempty"` // Tax: All the taxes associated with the transaction. Tax float64 `json:"tax,omitempty"` // TransactionId: The transaction ID with a length limit of 128 // characters. TransactionId string `json:"transactionId,omitempty"` // Value: Required. Total non-zero value associated with the // transaction. This value may include shipping, tax, or other // adjustments to the total value that you want to include. Value float64 `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Cost") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Cost") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaTransactionInfo: A transaction represents the entire purchase transaction.
func (*GoogleCloudDiscoveryengineV1betaTransactionInfo) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaTransactionInfo) MarshalJSON() ([]byte, error)
func (*GoogleCloudDiscoveryengineV1betaTransactionInfo) UnmarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaTransactionInfo) UnmarshalJSON(data []byte) error
type GoogleCloudDiscoveryengineV1betaUserEvent ¶
type GoogleCloudDiscoveryengineV1betaUserEvent struct { // Attributes: Extra user event features to include in the // recommendation model. These attributes must NOT contain data that // needs to be parsed or processed further, e.g. JSON or other // encodings. If you provide custom attributes for ingested user events, // also include them in the user events that you associate with // prediction requests. Custom attribute formatting must be consistent // between imported events and events provided with prediction requests. // This lets the Discovery Engine API use those custom attributes when // training models and serving predictions, which helps improve // recommendation quality. This field needs to pass all below criteria, // otherwise an INVALID_ARGUMENT error is returned: * The key must be a // UTF-8 encoded string with a length limit of 5,000 characters. * For // text attributes, at most 400 values are allowed. Empty values are not // allowed. Each value must be a UTF-8 encoded string with a length // limit of 256 characters. * For number attributes, at most 400 values // are allowed. For product recommendations, an example of extra user // information is traffic_channel, which is how a user arrives at the // site. Users can arrive at the site by coming to the site directly, // coming through Google search, or in other ways. Attributes map[string]GoogleCloudDiscoveryengineV1betaCustomAttribute `json:"attributes,omitempty"` // AttributionToken: Token to attribute an API response to user // action(s) to trigger the event. Highly recommended for user events // that are the result of PredictionService.Predict. This field enables // accurate attribution of recommendation model performance. The value // must be one of: * PredictResponse.attribution_token for events that // are the result of PredictionService.Predict. * // SearchResponse.attribution_token for events that are the result of // SearchService.Search. * CompleteQueryResponse.attribution_token for // events that are the result of SearchService.CompleteQuery. This token // enables us to accurately attribute page view or conversion completion // back to the event and the particular predict response containing this // clicked/purchased product. If user clicks on product K in the // recommendation results, pass PredictResponse.attribution_token as a // URL parameter to product K's page. When recording events on product // K's page, log the PredictResponse.attribution_token to this field. AttributionToken string `json:"attributionToken,omitempty"` // CompletionInfo: CompleteQuery API details related to the event. This // field should be set for `search` event when autocomplete function is // enabled and the user clicks a suggestion for search. CompletionInfo *GoogleCloudDiscoveryengineV1betaCompletionInfo `json:"completionInfo,omitempty"` // DirectUserRequest: Should set to true if the request is made directly // from the end user, in which case the UserEvent.user_info.user_agent // can be populated from the HTTP request. This flag should be set only // if the API request is made directly from the end user such as a // mobile app (and not if a gateway or a server is processing and // pushing the user events). This should not be set when using the // JavaScript tag in UserEventService.CollectUserEvent. DirectUserRequest bool `json:"directUserRequest,omitempty"` // Documents: List of Documents associated with this user event. This // field is optional except for the following event types: * `view-item` // * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a // `search` event, this field represents the documents returned to the // end user on the current page (the end user may have not finished // browsing the whole page yet). When a new page is returned to the end // user, after pagination/filtering/ordering even for the same query, a // new `search` event with different UserEvent.documents is desired. Documents []*GoogleCloudDiscoveryengineV1betaDocumentInfo `json:"documents,omitempty"` // EventTime: Only required for UserEventService.ImportUserEvents // method. Timestamp of when the user event happened. EventTime string `json:"eventTime,omitempty"` // EventType: Required. User event type. Allowed values are: Generic // values: * `search`: Search for Documents. * `view-item`: Detailed // page view of a Document. * `view-item-list`: View of a panel or // ordered list of Documents. * `view-home-page`: View of the home page. // * `view-category-page`: View of a category page, e.g. Home > Men > // Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, // e.g. in Retail online shopping * `purchase`: Purchase an item(s) // Media-related values: * `media-play`: Start/resume watching a video, // playing a song, etc. * `media-complete`: Finished or stopped midway // through a video, song, etc. EventType string `json:"eventType,omitempty"` // Filter: The filter syntax consists of an expression language for // constructing a predicate from one or more fields of the documents // being filtered. One example is for `search` events, the associated // SearchService.SearchRequest may contain a filter expression in // SearchService.SearchRequest.filter conforming to // https://google.aip.dev/160#filtering. Similarly, for `view-item-list` // events that are generated from a PredictionService.PredictRequest, // this field may be populated directly from // PredictionService.PredictRequest.filter conforming to // https://google.aip.dev/160#filtering. The value must be a UTF-8 // encoded string with a length limit of 1,000 characters. Otherwise, an // INVALID_ARGUMENT error is returned. Filter string `json:"filter,omitempty"` // MediaInfo: Media-specific info. MediaInfo *GoogleCloudDiscoveryengineV1betaMediaInfo `json:"mediaInfo,omitempty"` // PageInfo: Page metadata such as categories and other critical // information for certain event types such as `view-category-page`. PageInfo *GoogleCloudDiscoveryengineV1betaPageInfo `json:"pageInfo,omitempty"` // Panel: Panel metadata associated with this user event. Panel *GoogleCloudDiscoveryengineV1betaPanelInfo `json:"panel,omitempty"` // PromotionIds: The promotion IDs if this is an event associated with // promotions. Currently, this field is restricted to at most one ID. PromotionIds []string `json:"promotionIds,omitempty"` // SearchInfo: Search API details related to the event. This field // should be set for `search` event. SearchInfo *GoogleCloudDiscoveryengineV1betaSearchInfo `json:"searchInfo,omitempty"` // SessionId: A unique identifier for tracking a visitor session with a // length limit of 128 bytes. A session is an aggregation of an end user // behavior in a time span. A general guideline to populate the // session_id: 1. If user has no activity for 30 min, a new session_id // should be assigned. 2. The session_id should be unique across users, // suggest use uuid or add UserEvent.user_pseudo_id as prefix. SessionId string `json:"sessionId,omitempty"` // TagIds: A list of identifiers for the independent experiment groups // this user event belongs to. This is used to distinguish between user // events associated with different experiment setups on the customer // end. TagIds []string `json:"tagIds,omitempty"` // TransactionInfo: The transaction metadata (if any) associated with // this user event. TransactionInfo *GoogleCloudDiscoveryengineV1betaTransactionInfo `json:"transactionInfo,omitempty"` // UserInfo: Information about the end user. UserInfo *GoogleCloudDiscoveryengineV1betaUserInfo `json:"userInfo,omitempty"` // UserPseudoId: Required. A unique identifier for tracking visitors. // For example, this could be implemented with an HTTP cookie, which // should be able to uniquely identify a visitor on a single device. // This unique identifier should not change if the visitor log in/out of // the website. Do not set the field to the same fixed ID for different // users. This mixes the event history of those users together, which // results in degraded model quality. The field must be a UTF-8 encoded // string with a length limit of 128 characters. Otherwise, an // INVALID_ARGUMENT error is returned. The field should not contain PII // or user-data. We recommend to use Google Analytics Client ID // (https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) // for this field. UserPseudoId string `json:"userPseudoId,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Attributes") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Attributes") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaUserEvent: UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
func (*GoogleCloudDiscoveryengineV1betaUserEvent) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaUserEvent) MarshalJSON() ([]byte, error)
type GoogleCloudDiscoveryengineV1betaUserInfo ¶
type GoogleCloudDiscoveryengineV1betaUserInfo struct { // UserAgent: User agent as included in the HTTP header. Required for // getting SearchResponse.sponsored_results. The field must be a UTF-8 // encoded string with a length limit of 1,000 characters. Otherwise, an // INVALID_ARGUMENT error is returned. This should not be set when using // the client side event reporting with GTM or JavaScript tag in // UserEventService.CollectUserEvent or if direct_user_request is set. UserAgent string `json:"userAgent,omitempty"` // UserId: Highly recommended for logged-in users. Unique identifier for // logged-in user, such as a user name. Don't set for anonymous users. // Always use a hashed value for this ID. Don't set the field to the // same fixed ID for different users. This mixes the event history of // those users together, which results in degraded model quality. The // field must be a UTF-8 encoded string with a length limit of 128 // characters. Otherwise, an INVALID_ARGUMENT error is returned. UserId string `json:"userId,omitempty"` // ForceSendFields is a list of field names (e.g. "UserAgent") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "UserAgent") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDiscoveryengineV1betaUserInfo: Information of an end user.
func (*GoogleCloudDiscoveryengineV1betaUserInfo) MarshalJSON ¶
func (s *GoogleCloudDiscoveryengineV1betaUserInfo) MarshalJSON() ([]byte, error)
type GoogleLongrunningListOperationsResponse ¶
type GoogleLongrunningListOperationsResponse 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 []*GoogleLongrunningOperation `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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleLongrunningListOperationsResponse: The response message for Operations.ListOperations.
func (*GoogleLongrunningListOperationsResponse) MarshalJSON ¶
func (s *GoogleLongrunningListOperationsResponse) MarshalJSON() ([]byte, error)
type GoogleLongrunningOperation ¶
type GoogleLongrunningOperation 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 *GoogleRpcStatus `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 response of the operation in case of success. 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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleLongrunningOperation: This resource represents a long-running operation that is the result of a network API call.
func (*GoogleLongrunningOperation) MarshalJSON ¶
func (s *GoogleLongrunningOperation) MarshalJSON() ([]byte, error)
type GoogleProtobufEmpty ¶
type GoogleProtobufEmpty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
GoogleProtobufEmpty: 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 GoogleRpcStatus ¶
type GoogleRpcStatus 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. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleRpcStatus: 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).
func (*GoogleRpcStatus) MarshalJSON ¶
func (s *GoogleRpcStatus) MarshalJSON() ([]byte, error)
type GoogleTypeDate ¶
type GoogleTypeDate struct { // Day: Day of a month. Must be from 1 to 31 and valid for the year and // month, or 0 to specify a year by itself or a year and month where the // day isn't significant. Day int64 `json:"day,omitempty"` // Month: Month of a year. Must be from 1 to 12, or 0 to specify a year // without a month and day. Month int64 `json:"month,omitempty"` // Year: Year of the date. Must be from 1 to 9999, or 0 to specify a // date without a year. Year int64 `json:"year,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Day") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleTypeDate: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
func (*GoogleTypeDate) MarshalJSON ¶
func (s *GoogleTypeDate) MarshalJSON() ([]byte, error)
type ProjectsLocationsDataStoresBranchesDocumentsCreateCall ¶
type ProjectsLocationsDataStoresBranchesDocumentsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Context ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Do ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaDocument, error)
Do executes the "discoveryengine.projects.locations.dataStores.branches.documents.create" call. Exactly one of *GoogleCloudDiscoveryengineV1betaDocument or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDiscoveryengineV1betaDocument.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 (*ProjectsLocationsDataStoresBranchesDocumentsCreateCall) DocumentId ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) DocumentId(documentId string) *ProjectsLocationsDataStoresBranchesDocumentsCreateCall
DocumentId sets the optional parameter "documentId": Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
func (*ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Fields ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Header ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsDataStoresBranchesDocumentsDeleteCall ¶
type ProjectsLocationsDataStoresBranchesDocumentsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Context ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Do ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
Do executes the "discoveryengine.projects.locations.dataStores.branches.documents.delete" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.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 (*ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Fields ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Header ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsDataStoresBranchesDocumentsGetCall ¶
type ProjectsLocationsDataStoresBranchesDocumentsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresBranchesDocumentsGetCall) Context ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresBranchesDocumentsGetCall) Do ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaDocument, error)
Do executes the "discoveryengine.projects.locations.dataStores.branches.documents.get" call. Exactly one of *GoogleCloudDiscoveryengineV1betaDocument or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDiscoveryengineV1betaDocument.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 (*ProjectsLocationsDataStoresBranchesDocumentsGetCall) Fields ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresBranchesDocumentsGetCall) Header ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsDataStoresBranchesDocumentsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresBranchesDocumentsGetCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsDataStoresBranchesDocumentsImportCall ¶
type ProjectsLocationsDataStoresBranchesDocumentsImportCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresBranchesDocumentsImportCall) Context ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsImportCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsImportCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresBranchesDocumentsImportCall) Do ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsImportCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "discoveryengine.projects.locations.dataStores.branches.documents.import" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 (*ProjectsLocationsDataStoresBranchesDocumentsImportCall) Fields ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsImportCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsImportCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresBranchesDocumentsImportCall) Header ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsImportCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsDataStoresBranchesDocumentsListCall ¶
type ProjectsLocationsDataStoresBranchesDocumentsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresBranchesDocumentsListCall) Context ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresBranchesDocumentsListCall) Do ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaListDocumentsResponse, error)
Do executes the "discoveryengine.projects.locations.dataStores.branches.documents.list" call. Exactly one of *GoogleCloudDiscoveryengineV1betaListDocumentsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDiscoveryengineV1betaListDocumentsResponse.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 (*ProjectsLocationsDataStoresBranchesDocumentsListCall) Fields ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresBranchesDocumentsListCall) Header ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsDataStoresBranchesDocumentsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresBranchesDocumentsListCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsDataStoresBranchesDocumentsListCall) PageSize ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) PageSize(pageSize int64) *ProjectsLocationsDataStoresBranchesDocumentsListCall
PageSize sets the optional parameter "pageSize": Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
func (*ProjectsLocationsDataStoresBranchesDocumentsListCall) PageToken ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) PageToken(pageToken string) *ProjectsLocationsDataStoresBranchesDocumentsListCall
PageToken sets the optional parameter "pageToken": A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
func (*ProjectsLocationsDataStoresBranchesDocumentsListCall) Pages ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Pages(ctx context.Context, f func(*GoogleCloudDiscoveryengineV1betaListDocumentsResponse) 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 ProjectsLocationsDataStoresBranchesDocumentsPatchCall ¶
type ProjectsLocationsDataStoresBranchesDocumentsPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresBranchesDocumentsPatchCall) AllowMissing ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsPatchCall) AllowMissing(allowMissing bool) *ProjectsLocationsDataStoresBranchesDocumentsPatchCall
AllowMissing sets the optional parameter "allowMissing": If set to true, and the Document is not found, a new Document will be created.
func (*ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Context ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesDocumentsPatchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Do ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaDocument, error)
Do executes the "discoveryengine.projects.locations.dataStores.branches.documents.patch" call. Exactly one of *GoogleCloudDiscoveryengineV1betaDocument or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDiscoveryengineV1betaDocument.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 (*ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Fields ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesDocumentsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Header ¶
func (c *ProjectsLocationsDataStoresBranchesDocumentsPatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsDataStoresBranchesDocumentsService ¶
type ProjectsLocationsDataStoresBranchesDocumentsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsDataStoresBranchesDocumentsService ¶
func NewProjectsLocationsDataStoresBranchesDocumentsService(s *Service) *ProjectsLocationsDataStoresBranchesDocumentsService
func (*ProjectsLocationsDataStoresBranchesDocumentsService) Create ¶
func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Create(parent string, googleclouddiscoveryenginev1betadocument *GoogleCloudDiscoveryengineV1betaDocument) *ProjectsLocationsDataStoresBranchesDocumentsCreateCall
Create: Creates a Document.
- parent: The parent resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/bra nches/{branch}`.
func (*ProjectsLocationsDataStoresBranchesDocumentsService) Delete ¶
func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Delete(name string) *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall
Delete: Deletes a Document.
- name: Full resource name of Document, such as `projects/{project}/locations/{location}/dataStores/{data_store}/bra nches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.
func (*ProjectsLocationsDataStoresBranchesDocumentsService) Get ¶
func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Get(name string) *ProjectsLocationsDataStoresBranchesDocumentsGetCall
Get: Gets a Document.
- name: Full resource name of Document, such as `projects/{project}/locations/{location}/dataStores/{data_store}/bra nches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.
func (*ProjectsLocationsDataStoresBranchesDocumentsService) Import ¶
func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Import(parent string, googleclouddiscoveryenginev1betaimportdocumentsrequest *GoogleCloudDiscoveryengineV1betaImportDocumentsRequest) *ProjectsLocationsDataStoresBranchesDocumentsImportCall
Import: Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
- parent: The parent branch resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/bra nches/{branch}`. Requires create/update permission.
func (*ProjectsLocationsDataStoresBranchesDocumentsService) List ¶
func (r *ProjectsLocationsDataStoresBranchesDocumentsService) List(parent string) *ProjectsLocationsDataStoresBranchesDocumentsListCall
List: Gets a list of Documents.
- parent: The parent branch resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/bra nches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
func (*ProjectsLocationsDataStoresBranchesDocumentsService) Patch ¶
func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Patch(name string, googleclouddiscoveryenginev1betadocument *GoogleCloudDiscoveryengineV1betaDocument) *ProjectsLocationsDataStoresBranchesDocumentsPatchCall
Patch: Updates a Document.
- name: Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/dataStores/{data_store}/bra nches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
type ProjectsLocationsDataStoresBranchesOperationsGetCall ¶
type ProjectsLocationsDataStoresBranchesOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresBranchesOperationsGetCall) Context ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresBranchesOperationsGetCall) Do ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "discoveryengine.projects.locations.dataStores.branches.operations.get" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 (*ProjectsLocationsDataStoresBranchesOperationsGetCall) Fields ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresBranchesOperationsGetCall) Header ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsDataStoresBranchesOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresBranchesOperationsGetCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsDataStoresBranchesOperationsListCall ¶
type ProjectsLocationsDataStoresBranchesOperationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresBranchesOperationsListCall) Context ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Context(ctx context.Context) *ProjectsLocationsDataStoresBranchesOperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresBranchesOperationsListCall) Do ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
Do executes the "discoveryengine.projects.locations.dataStores.branches.operations.list" call. Exactly one of *GoogleLongrunningListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningListOperationsResponse.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 (*ProjectsLocationsDataStoresBranchesOperationsListCall) Fields ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresBranchesOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresBranchesOperationsListCall) Filter ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Filter(filter string) *ProjectsLocationsDataStoresBranchesOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsLocationsDataStoresBranchesOperationsListCall) Header ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsDataStoresBranchesOperationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresBranchesOperationsListCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsDataStoresBranchesOperationsListCall) PageSize ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsDataStoresBranchesOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsLocationsDataStoresBranchesOperationsListCall) PageToken ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) PageToken(pageToken string) *ProjectsLocationsDataStoresBranchesOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsLocationsDataStoresBranchesOperationsListCall) Pages ¶
func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) 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 ProjectsLocationsDataStoresBranchesOperationsService ¶
type ProjectsLocationsDataStoresBranchesOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsDataStoresBranchesOperationsService ¶
func NewProjectsLocationsDataStoresBranchesOperationsService(s *Service) *ProjectsLocationsDataStoresBranchesOperationsService
func (*ProjectsLocationsDataStoresBranchesOperationsService) Get ¶
func (r *ProjectsLocationsDataStoresBranchesOperationsService) Get(name string) *ProjectsLocationsDataStoresBranchesOperationsGetCall
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 (*ProjectsLocationsDataStoresBranchesOperationsService) List ¶
func (r *ProjectsLocationsDataStoresBranchesOperationsService) List(name string) *ProjectsLocationsDataStoresBranchesOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
- name: The name of the operation's parent resource.
type ProjectsLocationsDataStoresBranchesService ¶
type ProjectsLocationsDataStoresBranchesService struct { Documents *ProjectsLocationsDataStoresBranchesDocumentsService Operations *ProjectsLocationsDataStoresBranchesOperationsService // contains filtered or unexported fields }
func NewProjectsLocationsDataStoresBranchesService ¶
func NewProjectsLocationsDataStoresBranchesService(s *Service) *ProjectsLocationsDataStoresBranchesService
type ProjectsLocationsDataStoresModelsOperationsGetCall ¶
type ProjectsLocationsDataStoresModelsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresModelsOperationsGetCall) Context ¶
func (c *ProjectsLocationsDataStoresModelsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsDataStoresModelsOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresModelsOperationsGetCall) Do ¶
func (c *ProjectsLocationsDataStoresModelsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "discoveryengine.projects.locations.dataStores.models.operations.get" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 (*ProjectsLocationsDataStoresModelsOperationsGetCall) Fields ¶
func (c *ProjectsLocationsDataStoresModelsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresModelsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresModelsOperationsGetCall) Header ¶
func (c *ProjectsLocationsDataStoresModelsOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsDataStoresModelsOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsDataStoresModelsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresModelsOperationsGetCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsDataStoresModelsOperationsListCall ¶
type ProjectsLocationsDataStoresModelsOperationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresModelsOperationsListCall) Context ¶
func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsDataStoresModelsOperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresModelsOperationsListCall) Do ¶
func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
Do executes the "discoveryengine.projects.locations.dataStores.models.operations.list" call. Exactly one of *GoogleLongrunningListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningListOperationsResponse.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 (*ProjectsLocationsDataStoresModelsOperationsListCall) Fields ¶
func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresModelsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresModelsOperationsListCall) Filter ¶
func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Filter(filter string) *ProjectsLocationsDataStoresModelsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsLocationsDataStoresModelsOperationsListCall) Header ¶
func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsDataStoresModelsOperationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsDataStoresModelsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresModelsOperationsListCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsDataStoresModelsOperationsListCall) PageSize ¶
func (c *ProjectsLocationsDataStoresModelsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsDataStoresModelsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsLocationsDataStoresModelsOperationsListCall) PageToken ¶
func (c *ProjectsLocationsDataStoresModelsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsDataStoresModelsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsLocationsDataStoresModelsOperationsListCall) Pages ¶
func (c *ProjectsLocationsDataStoresModelsOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) 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 ProjectsLocationsDataStoresModelsOperationsService ¶
type ProjectsLocationsDataStoresModelsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsDataStoresModelsOperationsService ¶
func NewProjectsLocationsDataStoresModelsOperationsService(s *Service) *ProjectsLocationsDataStoresModelsOperationsService
func (*ProjectsLocationsDataStoresModelsOperationsService) Get ¶
func (r *ProjectsLocationsDataStoresModelsOperationsService) Get(name string) *ProjectsLocationsDataStoresModelsOperationsGetCall
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 (*ProjectsLocationsDataStoresModelsOperationsService) List ¶
func (r *ProjectsLocationsDataStoresModelsOperationsService) List(name string) *ProjectsLocationsDataStoresModelsOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
- name: The name of the operation's parent resource.
type ProjectsLocationsDataStoresModelsService ¶
type ProjectsLocationsDataStoresModelsService struct { Operations *ProjectsLocationsDataStoresModelsOperationsService // contains filtered or unexported fields }
func NewProjectsLocationsDataStoresModelsService ¶
func NewProjectsLocationsDataStoresModelsService(s *Service) *ProjectsLocationsDataStoresModelsService
type ProjectsLocationsDataStoresOperationsGetCall ¶
type ProjectsLocationsDataStoresOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresOperationsGetCall) Context ¶
func (c *ProjectsLocationsDataStoresOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsDataStoresOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresOperationsGetCall) Do ¶
func (c *ProjectsLocationsDataStoresOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "discoveryengine.projects.locations.dataStores.operations.get" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 (*ProjectsLocationsDataStoresOperationsGetCall) Fields ¶
func (c *ProjectsLocationsDataStoresOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresOperationsGetCall) Header ¶
func (c *ProjectsLocationsDataStoresOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsDataStoresOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsDataStoresOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresOperationsGetCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsDataStoresOperationsListCall ¶
type ProjectsLocationsDataStoresOperationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresOperationsListCall) Context ¶
func (c *ProjectsLocationsDataStoresOperationsListCall) Context(ctx context.Context) *ProjectsLocationsDataStoresOperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresOperationsListCall) Do ¶
func (c *ProjectsLocationsDataStoresOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
Do executes the "discoveryengine.projects.locations.dataStores.operations.list" call. Exactly one of *GoogleLongrunningListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningListOperationsResponse.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 (*ProjectsLocationsDataStoresOperationsListCall) Fields ¶
func (c *ProjectsLocationsDataStoresOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresOperationsListCall) Filter ¶
func (c *ProjectsLocationsDataStoresOperationsListCall) Filter(filter string) *ProjectsLocationsDataStoresOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsLocationsDataStoresOperationsListCall) Header ¶
func (c *ProjectsLocationsDataStoresOperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsDataStoresOperationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsDataStoresOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresOperationsListCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsDataStoresOperationsListCall) PageSize ¶
func (c *ProjectsLocationsDataStoresOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsDataStoresOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsLocationsDataStoresOperationsListCall) PageToken ¶
func (c *ProjectsLocationsDataStoresOperationsListCall) PageToken(pageToken string) *ProjectsLocationsDataStoresOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsLocationsDataStoresOperationsListCall) Pages ¶
func (c *ProjectsLocationsDataStoresOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) 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 ProjectsLocationsDataStoresOperationsService ¶
type ProjectsLocationsDataStoresOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsDataStoresOperationsService ¶
func NewProjectsLocationsDataStoresOperationsService(s *Service) *ProjectsLocationsDataStoresOperationsService
func (*ProjectsLocationsDataStoresOperationsService) Get ¶
func (r *ProjectsLocationsDataStoresOperationsService) Get(name string) *ProjectsLocationsDataStoresOperationsGetCall
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 (*ProjectsLocationsDataStoresOperationsService) List ¶
func (r *ProjectsLocationsDataStoresOperationsService) List(name string) *ProjectsLocationsDataStoresOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
- name: The name of the operation's parent resource.
type ProjectsLocationsDataStoresService ¶
type ProjectsLocationsDataStoresService struct { Branches *ProjectsLocationsDataStoresBranchesService Models *ProjectsLocationsDataStoresModelsService Operations *ProjectsLocationsDataStoresOperationsService ServingConfigs *ProjectsLocationsDataStoresServingConfigsService UserEvents *ProjectsLocationsDataStoresUserEventsService // contains filtered or unexported fields }
func NewProjectsLocationsDataStoresService ¶
func NewProjectsLocationsDataStoresService(s *Service) *ProjectsLocationsDataStoresService
type ProjectsLocationsDataStoresServingConfigsRecommendCall ¶
type ProjectsLocationsDataStoresServingConfigsRecommendCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresServingConfigsRecommendCall) Context ¶
func (c *ProjectsLocationsDataStoresServingConfigsRecommendCall) Context(ctx context.Context) *ProjectsLocationsDataStoresServingConfigsRecommendCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresServingConfigsRecommendCall) Do ¶
func (c *ProjectsLocationsDataStoresServingConfigsRecommendCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaRecommendResponse, error)
Do executes the "discoveryengine.projects.locations.dataStores.servingConfigs.recommend" call. Exactly one of *GoogleCloudDiscoveryengineV1betaRecommendResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDiscoveryengineV1betaRecommendResponse.ServerResponse.Head er 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 (*ProjectsLocationsDataStoresServingConfigsRecommendCall) Fields ¶
func (c *ProjectsLocationsDataStoresServingConfigsRecommendCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresServingConfigsRecommendCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresServingConfigsRecommendCall) Header ¶
func (c *ProjectsLocationsDataStoresServingConfigsRecommendCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsDataStoresServingConfigsService ¶
type ProjectsLocationsDataStoresServingConfigsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsDataStoresServingConfigsService ¶
func NewProjectsLocationsDataStoresServingConfigsService(s *Service) *ProjectsLocationsDataStoresServingConfigsService
func (*ProjectsLocationsDataStoresServingConfigsService) Recommend ¶
func (r *ProjectsLocationsDataStoresServingConfigsService) Recommend(servingConfig string, googleclouddiscoveryenginev1betarecommendrequest *GoogleCloudDiscoveryengineV1betaRecommendRequest) *ProjectsLocationsDataStoresServingConfigsRecommendCall
Recommend: Makes a recommendation, which requires a contextual user event.
- servingConfig: Full resource name of the format: projects/*/locations/global/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.
type ProjectsLocationsDataStoresUserEventsCollectCall ¶
type ProjectsLocationsDataStoresUserEventsCollectCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresUserEventsCollectCall) Context ¶
func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Context(ctx context.Context) *ProjectsLocationsDataStoresUserEventsCollectCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresUserEventsCollectCall) Do ¶
func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Do(opts ...googleapi.CallOption) (*GoogleApiHttpBody, error)
Do executes the "discoveryengine.projects.locations.dataStores.userEvents.collect" call. Exactly one of *GoogleApiHttpBody or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleApiHttpBody.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 (*ProjectsLocationsDataStoresUserEventsCollectCall) Ets ¶
func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Ets(ets int64) *ProjectsLocationsDataStoresUserEventsCollectCall
Ets sets the optional parameter "ets": The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
func (*ProjectsLocationsDataStoresUserEventsCollectCall) Fields ¶
func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresUserEventsCollectCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresUserEventsCollectCall) Header ¶
func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsDataStoresUserEventsCollectCall) IfNoneMatch ¶
func (c *ProjectsLocationsDataStoresUserEventsCollectCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataStoresUserEventsCollectCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsDataStoresUserEventsCollectCall) Uri ¶
func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Uri(uri string) *ProjectsLocationsDataStoresUserEventsCollectCall
Uri sets the optional parameter "uri": The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.
func (*ProjectsLocationsDataStoresUserEventsCollectCall) UserEvent ¶
func (c *ProjectsLocationsDataStoresUserEventsCollectCall) UserEvent(userEvent string) *ProjectsLocationsDataStoresUserEventsCollectCall
UserEvent sets the optional parameter "userEvent": Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
type ProjectsLocationsDataStoresUserEventsImportCall ¶
type ProjectsLocationsDataStoresUserEventsImportCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresUserEventsImportCall) Context ¶
func (c *ProjectsLocationsDataStoresUserEventsImportCall) Context(ctx context.Context) *ProjectsLocationsDataStoresUserEventsImportCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresUserEventsImportCall) Do ¶
func (c *ProjectsLocationsDataStoresUserEventsImportCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "discoveryengine.projects.locations.dataStores.userEvents.import" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 (*ProjectsLocationsDataStoresUserEventsImportCall) Fields ¶
func (c *ProjectsLocationsDataStoresUserEventsImportCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresUserEventsImportCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresUserEventsImportCall) Header ¶
func (c *ProjectsLocationsDataStoresUserEventsImportCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsDataStoresUserEventsService ¶
type ProjectsLocationsDataStoresUserEventsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsDataStoresUserEventsService ¶
func NewProjectsLocationsDataStoresUserEventsService(s *Service) *ProjectsLocationsDataStoresUserEventsService
func (*ProjectsLocationsDataStoresUserEventsService) Collect ¶
func (r *ProjectsLocationsDataStoresUserEventsService) Collect(parent string) *ProjectsLocationsDataStoresUserEventsCollectCall
Collect: Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
- parent: The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`.
func (*ProjectsLocationsDataStoresUserEventsService) Import ¶
func (r *ProjectsLocationsDataStoresUserEventsService) Import(parent string, googleclouddiscoveryenginev1betaimportusereventsrequest *GoogleCloudDiscoveryengineV1betaImportUserEventsRequest) *ProjectsLocationsDataStoresUserEventsImportCall
Import: Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
- parent: Parent DataStore resource name, of the form `projects/{project}/locations/{location}/dataStores/{data_store}`.
func (*ProjectsLocationsDataStoresUserEventsService) Write ¶
func (r *ProjectsLocationsDataStoresUserEventsService) Write(parent string, googleclouddiscoveryenginev1betauserevent *GoogleCloudDiscoveryengineV1betaUserEvent) *ProjectsLocationsDataStoresUserEventsWriteCall
Write: Writes a single user event.
- parent: The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`.
type ProjectsLocationsDataStoresUserEventsWriteCall ¶
type ProjectsLocationsDataStoresUserEventsWriteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsDataStoresUserEventsWriteCall) Context ¶
func (c *ProjectsLocationsDataStoresUserEventsWriteCall) Context(ctx context.Context) *ProjectsLocationsDataStoresUserEventsWriteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsDataStoresUserEventsWriteCall) Do ¶
func (c *ProjectsLocationsDataStoresUserEventsWriteCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaUserEvent, error)
Do executes the "discoveryengine.projects.locations.dataStores.userEvents.write" call. Exactly one of *GoogleCloudDiscoveryengineV1betaUserEvent or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDiscoveryengineV1betaUserEvent.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 (*ProjectsLocationsDataStoresUserEventsWriteCall) Fields ¶
func (c *ProjectsLocationsDataStoresUserEventsWriteCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresUserEventsWriteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsDataStoresUserEventsWriteCall) Header ¶
func (c *ProjectsLocationsDataStoresUserEventsWriteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsGetCall) Do ¶
func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "discoveryengine.projects.locations.operations.get" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 information.
func (*ProjectsLocationsOperationsGetCall) Header ¶
func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsListCall) Do ¶
func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
Do executes the "discoveryengine.projects.locations.operations.list" call. Exactly one of *GoogleLongrunningListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningListOperationsResponse.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 information.
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 an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
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(*GoogleLongrunningListOperationsResponse) 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) 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`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
- name: The name of the operation's parent resource.
type ProjectsLocationsService ¶
type ProjectsLocationsService struct { DataStores *ProjectsLocationsDataStoresService Operations *ProjectsLocationsOperationsService // contains filtered or unexported fields }
func NewProjectsLocationsService ¶
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
type ProjectsOperationsGetCall ¶
type ProjectsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsOperationsGetCall) Context ¶
func (c *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsOperationsGetCall) Do ¶
func (c *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "discoveryengine.projects.operations.get" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 (*ProjectsOperationsGetCall) Fields ¶
func (c *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsOperationsGetCall) Header ¶
func (c *ProjectsOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsOperationsListCall ¶
type ProjectsOperationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsOperationsListCall) Context ¶
func (c *ProjectsOperationsListCall) Context(ctx context.Context) *ProjectsOperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsOperationsListCall) Do ¶
func (c *ProjectsOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
Do executes the "discoveryengine.projects.operations.list" call. Exactly one of *GoogleLongrunningListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningListOperationsResponse.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 (*ProjectsOperationsListCall) Fields ¶
func (c *ProjectsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsOperationsListCall) Filter ¶
func (c *ProjectsOperationsListCall) Filter(filter string) *ProjectsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsOperationsListCall) Header ¶
func (c *ProjectsOperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsOperationsListCall) IfNoneMatch ¶
func (c *ProjectsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsOperationsListCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsOperationsListCall) PageSize ¶
func (c *ProjectsOperationsListCall) PageSize(pageSize int64) *ProjectsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsOperationsListCall) PageToken ¶
func (c *ProjectsOperationsListCall) PageToken(pageToken string) *ProjectsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsOperationsListCall) Pages ¶
func (c *ProjectsOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) 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 ProjectsOperationsService ¶
type ProjectsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsOperationsService ¶
func NewProjectsOperationsService(s *Service) *ProjectsOperationsService
func (*ProjectsOperationsService) Get ¶
func (r *ProjectsOperationsService) Get(name string) *ProjectsOperationsGetCall
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 (*ProjectsOperationsService) List ¶
func (r *ProjectsOperationsService) List(name string) *ProjectsOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
- name: The name of the operation's parent resource.
type ProjectsService ¶
type ProjectsService struct { Locations *ProjectsLocationsService Operations *ProjectsOperationsService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
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
deprecated
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 ¶
NewService creates a new Service.