gestione documentale avanzata 1 parte

This commit is contained in:
2026-05-28 09:34:28 +02:00
parent 3471befb1a
commit f2b0833b90
34482 changed files with 4312269 additions and 546 deletions
@@ -0,0 +1,92 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1APIKeySecurityScheme extends \Google\Model
{
/**
* Description of this security scheme.
*
* @var string
*/
public $description;
/**
* Location of the API key, valid values are "query", "header", or "cookie"
*
* @var string
*/
public $location;
/**
* Name of the header, query or cookie parameter to be used.
*
* @var string
*/
public $name;
/**
* Description of this security scheme.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Location of the API key, valid values are "query", "header", or "cookie"
*
* @param string $location
*/
public function setLocation($location)
{
$this->location = $location;
}
/**
* @return string
*/
public function getLocation()
{
return $this->location;
}
/**
* Name of the header, query or cookie parameter to be used.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1APIKeySecurityScheme::class, 'Google_Service_DiscoveryEngine_A2aV1APIKeySecurityScheme');
@@ -0,0 +1,89 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1AgentCapabilities extends \Google\Collection
{
protected $collection_key = 'extensions';
protected $extensionsType = A2aV1AgentExtension::class;
protected $extensionsDataType = 'array';
/**
* If the agent can send push notifications to the clients webhook
*
* @var bool
*/
public $pushNotifications;
/**
* If the agent will support streaming responses
*
* @var bool
*/
public $streaming;
/**
* Extensions supported by this agent.
*
* @param A2aV1AgentExtension[] $extensions
*/
public function setExtensions($extensions)
{
$this->extensions = $extensions;
}
/**
* @return A2aV1AgentExtension[]
*/
public function getExtensions()
{
return $this->extensions;
}
/**
* If the agent can send push notifications to the clients webhook
*
* @param bool $pushNotifications
*/
public function setPushNotifications($pushNotifications)
{
$this->pushNotifications = $pushNotifications;
}
/**
* @return bool
*/
public function getPushNotifications()
{
return $this->pushNotifications;
}
/**
* If the agent will support streaming responses
*
* @param bool $streaming
*/
public function setStreaming($streaming)
{
$this->streaming = $streaming;
}
/**
* @return bool
*/
public function getStreaming()
{
return $this->streaming;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1AgentCapabilities::class, 'Google_Service_DiscoveryEngine_A2aV1AgentCapabilities');
@@ -0,0 +1,416 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1AgentCard extends \Google\Collection
{
protected $collection_key = 'skills';
protected $additionalInterfacesType = A2aV1AgentInterface::class;
protected $additionalInterfacesDataType = 'array';
protected $capabilitiesType = A2aV1AgentCapabilities::class;
protected $capabilitiesDataType = '';
/**
* protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction
* modes that the agent supports across all skills. This can be overridden per
* skill. Defined as mime types.
*
* @var string[]
*/
public $defaultInputModes;
/**
* The mime types supported as outputs from this agent.
*
* @var string[]
*/
public $defaultOutputModes;
/**
* A description of the agent's domain of action/solution space. Example:
* "Agent that helps users with recipes and cooking."
*
* @var string
*/
public $description;
/**
* A url to provide additional documentation about the agent.
*
* @var string
*/
public $documentationUrl;
/**
* An optional URL to an icon for the agent.
*
* @var string
*/
public $iconUrl;
/**
* A human readable name for the agent. Example: "Recipe Agent"
*
* @var string
*/
public $name;
/**
* The transport of the preferred endpoint. If empty, defaults to JSONRPC.
*
* @var string
*/
public $preferredTransport;
/**
* The version of the A2A protocol this agent supports.
*
* @var string
*/
public $protocolVersion;
protected $providerType = A2aV1AgentProvider::class;
protected $providerDataType = '';
protected $securityType = A2aV1Security::class;
protected $securityDataType = 'array';
protected $securitySchemesType = A2aV1SecurityScheme::class;
protected $securitySchemesDataType = 'map';
protected $signaturesType = A2aV1AgentCardSignature::class;
protected $signaturesDataType = 'array';
protected $skillsType = A2aV1AgentSkill::class;
protected $skillsDataType = 'array';
/**
* Whether the agent supports providing an extended agent card when the user
* is authenticated, i.e. is the card from .well-known different than the card
* from GetAgentCard.
*
* @var bool
*/
public $supportsAuthenticatedExtendedCard;
/**
* A URL to the address the agent is hosted at. This represents the preferred
* endpoint as declared by the agent.
*
* @var string
*/
public $url;
/**
* The version of the agent. Example: "1.0.0"
*
* @var string
*/
public $version;
/**
* Announcement of additional supported transports. Client can use any of the
* supported transports.
*
* @param A2aV1AgentInterface[] $additionalInterfaces
*/
public function setAdditionalInterfaces($additionalInterfaces)
{
$this->additionalInterfaces = $additionalInterfaces;
}
/**
* @return A2aV1AgentInterface[]
*/
public function getAdditionalInterfaces()
{
return $this->additionalInterfaces;
}
/**
* A2A Capability set supported by the agent.
*
* @param A2aV1AgentCapabilities $capabilities
*/
public function setCapabilities(A2aV1AgentCapabilities $capabilities)
{
$this->capabilities = $capabilities;
}
/**
* @return A2aV1AgentCapabilities
*/
public function getCapabilities()
{
return $this->capabilities;
}
/**
* protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction
* modes that the agent supports across all skills. This can be overridden per
* skill. Defined as mime types.
*
* @param string[] $defaultInputModes
*/
public function setDefaultInputModes($defaultInputModes)
{
$this->defaultInputModes = $defaultInputModes;
}
/**
* @return string[]
*/
public function getDefaultInputModes()
{
return $this->defaultInputModes;
}
/**
* The mime types supported as outputs from this agent.
*
* @param string[] $defaultOutputModes
*/
public function setDefaultOutputModes($defaultOutputModes)
{
$this->defaultOutputModes = $defaultOutputModes;
}
/**
* @return string[]
*/
public function getDefaultOutputModes()
{
return $this->defaultOutputModes;
}
/**
* A description of the agent's domain of action/solution space. Example:
* "Agent that helps users with recipes and cooking."
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* A url to provide additional documentation about the agent.
*
* @param string $documentationUrl
*/
public function setDocumentationUrl($documentationUrl)
{
$this->documentationUrl = $documentationUrl;
}
/**
* @return string
*/
public function getDocumentationUrl()
{
return $this->documentationUrl;
}
/**
* An optional URL to an icon for the agent.
*
* @param string $iconUrl
*/
public function setIconUrl($iconUrl)
{
$this->iconUrl = $iconUrl;
}
/**
* @return string
*/
public function getIconUrl()
{
return $this->iconUrl;
}
/**
* A human readable name for the agent. Example: "Recipe Agent"
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The transport of the preferred endpoint. If empty, defaults to JSONRPC.
*
* @param string $preferredTransport
*/
public function setPreferredTransport($preferredTransport)
{
$this->preferredTransport = $preferredTransport;
}
/**
* @return string
*/
public function getPreferredTransport()
{
return $this->preferredTransport;
}
/**
* The version of the A2A protocol this agent supports.
*
* @param string $protocolVersion
*/
public function setProtocolVersion($protocolVersion)
{
$this->protocolVersion = $protocolVersion;
}
/**
* @return string
*/
public function getProtocolVersion()
{
return $this->protocolVersion;
}
/**
* The service provider of the agent.
*
* @param A2aV1AgentProvider $provider
*/
public function setProvider(A2aV1AgentProvider $provider)
{
$this->provider = $provider;
}
/**
* @return A2aV1AgentProvider
*/
public function getProvider()
{
return $this->provider;
}
/**
* protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security requirements for
* contacting the agent. This list can be seen as an OR of ANDs. Each object
* in the list describes one possible set of security requirements that must
* be present on a request. This allows specifying, for example, "callers must
* either use OAuth OR an API Key AND mTLS." Example: security { schemes {
* key: "oauth" value { list: ["read"] } } } security { schemes { key: "api-
* key" } schemes { key: "mtls" } }
*
* @param A2aV1Security[] $security
*/
public function setSecurity($security)
{
$this->security = $security;
}
/**
* @return A2aV1Security[]
*/
public function getSecurity()
{
return $this->security;
}
/**
* The security scheme details used for authenticating with this agent.
*
* @param A2aV1SecurityScheme[] $securitySchemes
*/
public function setSecuritySchemes($securitySchemes)
{
$this->securitySchemes = $securitySchemes;
}
/**
* @return A2aV1SecurityScheme[]
*/
public function getSecuritySchemes()
{
return $this->securitySchemes;
}
/**
* JSON Web Signatures computed for this AgentCard.
*
* @param A2aV1AgentCardSignature[] $signatures
*/
public function setSignatures($signatures)
{
$this->signatures = $signatures;
}
/**
* @return A2aV1AgentCardSignature[]
*/
public function getSignatures()
{
return $this->signatures;
}
/**
* Skills represent a unit of ability an agent can perform. This may somewhat
* abstract but represents a more focused set of actions that the agent is
* highly likely to succeed at.
*
* @param A2aV1AgentSkill[] $skills
*/
public function setSkills($skills)
{
$this->skills = $skills;
}
/**
* @return A2aV1AgentSkill[]
*/
public function getSkills()
{
return $this->skills;
}
/**
* Whether the agent supports providing an extended agent card when the user
* is authenticated, i.e. is the card from .well-known different than the card
* from GetAgentCard.
*
* @param bool $supportsAuthenticatedExtendedCard
*/
public function setSupportsAuthenticatedExtendedCard($supportsAuthenticatedExtendedCard)
{
$this->supportsAuthenticatedExtendedCard = $supportsAuthenticatedExtendedCard;
}
/**
* @return bool
*/
public function getSupportsAuthenticatedExtendedCard()
{
return $this->supportsAuthenticatedExtendedCard;
}
/**
* A URL to the address the agent is hosted at. This represents the preferred
* endpoint as declared by the agent.
*
* @param string $url
*/
public function setUrl($url)
{
$this->url = $url;
}
/**
* @return string
*/
public function getUrl()
{
return $this->url;
}
/**
* The version of the agent. Example: "1.0.0"
*
* @param string $version
*/
public function setVersion($version)
{
$this->version = $version;
}
/**
* @return string
*/
public function getVersion()
{
return $this->version;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1AgentCard::class, 'Google_Service_DiscoveryEngine_A2aV1AgentCard');
@@ -0,0 +1,94 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1AgentCardSignature extends \Google\Model
{
/**
* The unprotected JWS header values.
*
* @var array[]
*/
public $header;
/**
* Required. The protected JWS header for the signature. This is always a
* base64url-encoded JSON object. Required.
*
* @var string
*/
public $protected;
/**
* Required. The computed signature, base64url-encoded. Required.
*
* @var string
*/
public $signature;
/**
* The unprotected JWS header values.
*
* @param array[] $header
*/
public function setHeader($header)
{
$this->header = $header;
}
/**
* @return array[]
*/
public function getHeader()
{
return $this->header;
}
/**
* Required. The protected JWS header for the signature. This is always a
* base64url-encoded JSON object. Required.
*
* @param string $protected
*/
public function setProtected($protected)
{
$this->protected = $protected;
}
/**
* @return string
*/
public function getProtected()
{
return $this->protected;
}
/**
* Required. The computed signature, base64url-encoded. Required.
*
* @param string $signature
*/
public function setSignature($signature)
{
$this->signature = $signature;
}
/**
* @return string
*/
public function getSignature()
{
return $this->signature;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1AgentCardSignature::class, 'Google_Service_DiscoveryEngine_A2aV1AgentCardSignature');
@@ -0,0 +1,120 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1AgentExtension extends \Google\Model
{
/**
* A description of how this agent uses this extension. Example: "Google OAuth
* 2.0 authentication"
*
* @var string
*/
public $description;
/**
* Optional configuration for the extension.
*
* @var array[]
*/
public $params;
/**
* Whether the client must follow specific requirements of the extension.
* Example: false
*
* @var bool
*/
public $required;
/**
* The URI of the extension. Example:
* "https://developers.google.com/identity/protocols/oauth2"
*
* @var string
*/
public $uri;
/**
* A description of how this agent uses this extension. Example: "Google OAuth
* 2.0 authentication"
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Optional configuration for the extension.
*
* @param array[] $params
*/
public function setParams($params)
{
$this->params = $params;
}
/**
* @return array[]
*/
public function getParams()
{
return $this->params;
}
/**
* Whether the client must follow specific requirements of the extension.
* Example: false
*
* @param bool $required
*/
public function setRequired($required)
{
$this->required = $required;
}
/**
* @return bool
*/
public function getRequired()
{
return $this->required;
}
/**
* The URI of the extension. Example:
* "https://developers.google.com/identity/protocols/oauth2"
*
* @param string $uri
*/
public function setUri($uri)
{
$this->uri = $uri;
}
/**
* @return string
*/
public function getUri()
{
return $this->uri;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1AgentExtension::class, 'Google_Service_DiscoveryEngine_A2aV1AgentExtension');
@@ -0,0 +1,98 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1AgentInterface extends \Google\Model
{
/**
* Tenant to be set in the request when calling the agent. Experimental, might
* still change for 1.0 release.
*
* @var string
*/
public $tenant;
/**
* The transport supported this url. This is an open form string, to be easily
* extended for many transport protocols. The core ones officially supported
* are JSONRPC, GRPC and HTTP+JSON.
*
* @var string
*/
public $transport;
/**
* The url this interface is found at.
*
* @var string
*/
public $url;
/**
* Tenant to be set in the request when calling the agent. Experimental, might
* still change for 1.0 release.
*
* @param string $tenant
*/
public function setTenant($tenant)
{
$this->tenant = $tenant;
}
/**
* @return string
*/
public function getTenant()
{
return $this->tenant;
}
/**
* The transport supported this url. This is an open form string, to be easily
* extended for many transport protocols. The core ones officially supported
* are JSONRPC, GRPC and HTTP+JSON.
*
* @param string $transport
*/
public function setTransport($transport)
{
$this->transport = $transport;
}
/**
* @return string
*/
public function getTransport()
{
return $this->transport;
}
/**
* The url this interface is found at.
*
* @param string $url
*/
public function setUrl($url)
{
$this->url = $url;
}
/**
* @return string
*/
public function getUrl()
{
return $this->url;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1AgentInterface::class, 'Google_Service_DiscoveryEngine_A2aV1AgentInterface');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1AgentProvider extends \Google\Model
{
/**
* The providers organization name Example: "Google"
*
* @var string
*/
public $organization;
/**
* The providers reference url Example: "https://ai.google.dev"
*
* @var string
*/
public $url;
/**
* The providers organization name Example: "Google"
*
* @param string $organization
*/
public function setOrganization($organization)
{
$this->organization = $organization;
}
/**
* @return string
*/
public function getOrganization()
{
return $this->organization;
}
/**
* The providers reference url Example: "https://ai.google.dev"
*
* @param string $url
*/
public function setUrl($url)
{
$this->url = $url;
}
/**
* @return string
*/
public function getUrl()
{
return $this->url;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1AgentProvider::class, 'Google_Service_DiscoveryEngine_A2aV1AgentProvider');
@@ -0,0 +1,210 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1AgentSkill extends \Google\Collection
{
protected $collection_key = 'tags';
/**
* A human (or llm) readable description of the skill details and behaviors.
*
* @var string
*/
public $description;
/**
* A set of example queries that this skill is designed to address. These
* examples should help the caller to understand how to craft requests to the
* agent to achieve specific goals. Example: ["I need a recipe for bread"]
*
* @var string[]
*/
public $examples;
/**
* Unique identifier of the skill within this agent.
*
* @var string
*/
public $id;
/**
* Possible input modalities supported.
*
* @var string[]
*/
public $inputModes;
/**
* A human readable name for the skill.
*
* @var string
*/
public $name;
/**
* Possible output modalities produced
*
* @var string[]
*/
public $outputModes;
protected $securityType = A2aV1Security::class;
protected $securityDataType = 'array';
/**
* A set of tags for the skill to enhance categorization/utilization. Example:
* ["cooking", "customer support", "billing"]
*
* @var string[]
*/
public $tags;
/**
* A human (or llm) readable description of the skill details and behaviors.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* A set of example queries that this skill is designed to address. These
* examples should help the caller to understand how to craft requests to the
* agent to achieve specific goals. Example: ["I need a recipe for bread"]
*
* @param string[] $examples
*/
public function setExamples($examples)
{
$this->examples = $examples;
}
/**
* @return string[]
*/
public function getExamples()
{
return $this->examples;
}
/**
* Unique identifier of the skill within this agent.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Possible input modalities supported.
*
* @param string[] $inputModes
*/
public function setInputModes($inputModes)
{
$this->inputModes = $inputModes;
}
/**
* @return string[]
*/
public function getInputModes()
{
return $this->inputModes;
}
/**
* A human readable name for the skill.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Possible output modalities produced
*
* @param string[] $outputModes
*/
public function setOutputModes($outputModes)
{
$this->outputModes = $outputModes;
}
/**
* @return string[]
*/
public function getOutputModes()
{
return $this->outputModes;
}
/**
* protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security schemes
* necessary for the agent to leverage this skill. As in the overall
* AgentCard.security, this list represents a logical OR of security
* requirement objects. Each object is a set of security schemes that must be
* used together (a logical AND). protolint:enable
* REPEATED_FIELD_NAMES_PLURALIZED
*
* @param A2aV1Security[] $security
*/
public function setSecurity($security)
{
$this->security = $security;
}
/**
* @return A2aV1Security[]
*/
public function getSecurity()
{
return $this->security;
}
/**
* A set of tags for the skill to enhance categorization/utilization. Example:
* ["cooking", "customer support", "billing"]
*
* @param string[] $tags
*/
public function setTags($tags)
{
$this->tags = $tags;
}
/**
* @return string[]
*/
public function getTags()
{
return $this->tags;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1AgentSkill::class, 'Google_Service_DiscoveryEngine_A2aV1AgentSkill');
@@ -0,0 +1,157 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1Artifact extends \Google\Collection
{
protected $collection_key = 'parts';
/**
* Unique identifier (e.g. UUID) for the artifact. It must be at least unique
* within a task.
*
* @var string
*/
public $artifactId;
/**
* A human readable description of the artifact, optional.
*
* @var string
*/
public $description;
/**
* The URIs of extensions that are present or contributed to this Artifact.
*
* @var string[]
*/
public $extensions;
/**
* Optional metadata included with the artifact.
*
* @var array[]
*/
public $metadata;
/**
* A human readable name for the artifact.
*
* @var string
*/
public $name;
protected $partsType = A2aV1Part::class;
protected $partsDataType = 'array';
/**
* Unique identifier (e.g. UUID) for the artifact. It must be at least unique
* within a task.
*
* @param string $artifactId
*/
public function setArtifactId($artifactId)
{
$this->artifactId = $artifactId;
}
/**
* @return string
*/
public function getArtifactId()
{
return $this->artifactId;
}
/**
* A human readable description of the artifact, optional.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* The URIs of extensions that are present or contributed to this Artifact.
*
* @param string[] $extensions
*/
public function setExtensions($extensions)
{
$this->extensions = $extensions;
}
/**
* @return string[]
*/
public function getExtensions()
{
return $this->extensions;
}
/**
* Optional metadata included with the artifact.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* A human readable name for the artifact.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The content of the artifact.
*
* @param A2aV1Part[] $parts
*/
public function setParts($parts)
{
$this->parts = $parts;
}
/**
* @return A2aV1Part[]
*/
public function getParts()
{
return $this->parts;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1Artifact::class, 'Google_Service_DiscoveryEngine_A2aV1Artifact');
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1AuthenticationInfo extends \Google\Collection
{
protected $collection_key = 'schemes';
/**
* Optional credentials
*
* @var string
*/
public $credentials;
/**
* Supported authentication schemes - e.g. Basic, Bearer, etc
*
* @var string[]
*/
public $schemes;
/**
* Optional credentials
*
* @param string $credentials
*/
public function setCredentials($credentials)
{
$this->credentials = $credentials;
}
/**
* @return string
*/
public function getCredentials()
{
return $this->credentials;
}
/**
* Supported authentication schemes - e.g. Basic, Bearer, etc
*
* @param string[] $schemes
*/
public function setSchemes($schemes)
{
$this->schemes = $schemes;
}
/**
* @return string[]
*/
public function getSchemes()
{
return $this->schemes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1AuthenticationInfo::class, 'Google_Service_DiscoveryEngine_A2aV1AuthenticationInfo');
@@ -0,0 +1,122 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1AuthorizationCodeOAuthFlow extends \Google\Model
{
/**
* The authorization URL to be used for this flow. This MUST be in the form of
* a URL. The OAuth2 standard requires the use of TLS
*
* @var string
*/
public $authorizationUrl;
/**
* The URL to be used for obtaining refresh tokens. This MUST be in the form
* of a URL. The OAuth2 standard requires the use of TLS.
*
* @var string
*/
public $refreshUrl;
/**
* The available scopes for the OAuth2 security scheme. A map between the
* scope name and a short description for it. The map MAY be empty.
*
* @var string[]
*/
public $scopes;
/**
* The token URL to be used for this flow. This MUST be in the form of a URL.
* The OAuth2 standard requires the use of TLS.
*
* @var string
*/
public $tokenUrl;
/**
* The authorization URL to be used for this flow. This MUST be in the form of
* a URL. The OAuth2 standard requires the use of TLS
*
* @param string $authorizationUrl
*/
public function setAuthorizationUrl($authorizationUrl)
{
$this->authorizationUrl = $authorizationUrl;
}
/**
* @return string
*/
public function getAuthorizationUrl()
{
return $this->authorizationUrl;
}
/**
* The URL to be used for obtaining refresh tokens. This MUST be in the form
* of a URL. The OAuth2 standard requires the use of TLS.
*
* @param string $refreshUrl
*/
public function setRefreshUrl($refreshUrl)
{
$this->refreshUrl = $refreshUrl;
}
/**
* @return string
*/
public function getRefreshUrl()
{
return $this->refreshUrl;
}
/**
* The available scopes for the OAuth2 security scheme. A map between the
* scope name and a short description for it. The map MAY be empty.
*
* @param string[] $scopes
*/
public function setScopes($scopes)
{
$this->scopes = $scopes;
}
/**
* @return string[]
*/
public function getScopes()
{
return $this->scopes;
}
/**
* The token URL to be used for this flow. This MUST be in the form of a URL.
* The OAuth2 standard requires the use of TLS.
*
* @param string $tokenUrl
*/
public function setTokenUrl($tokenUrl)
{
$this->tokenUrl = $tokenUrl;
}
/**
* @return string
*/
public function getTokenUrl()
{
return $this->tokenUrl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1AuthorizationCodeOAuthFlow::class, 'Google_Service_DiscoveryEngine_A2aV1AuthorizationCodeOAuthFlow');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1CancelTaskRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1CancelTaskRequest::class, 'Google_Service_DiscoveryEngine_A2aV1CancelTaskRequest');
@@ -0,0 +1,98 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1ClientCredentialsOAuthFlow extends \Google\Model
{
/**
* The URL to be used for obtaining refresh tokens. This MUST be in the form
* of a URL. The OAuth2 standard requires the use of TLS.
*
* @var string
*/
public $refreshUrl;
/**
* The available scopes for the OAuth2 security scheme. A map between the
* scope name and a short description for it. The map MAY be empty.
*
* @var string[]
*/
public $scopes;
/**
* The token URL to be used for this flow. This MUST be in the form of a URL.
* The OAuth2 standard requires the use of TLS.
*
* @var string
*/
public $tokenUrl;
/**
* The URL to be used for obtaining refresh tokens. This MUST be in the form
* of a URL. The OAuth2 standard requires the use of TLS.
*
* @param string $refreshUrl
*/
public function setRefreshUrl($refreshUrl)
{
$this->refreshUrl = $refreshUrl;
}
/**
* @return string
*/
public function getRefreshUrl()
{
return $this->refreshUrl;
}
/**
* The available scopes for the OAuth2 security scheme. A map between the
* scope name and a short description for it. The map MAY be empty.
*
* @param string[] $scopes
*/
public function setScopes($scopes)
{
$this->scopes = $scopes;
}
/**
* @return string[]
*/
public function getScopes()
{
return $this->scopes;
}
/**
* The token URL to be used for this flow. This MUST be in the form of a URL.
* The OAuth2 standard requires the use of TLS.
*
* @param string $tokenUrl
*/
public function setTokenUrl($tokenUrl)
{
$this->tokenUrl = $tokenUrl;
}
/**
* @return string
*/
public function getTokenUrl()
{
return $this->tokenUrl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1ClientCredentialsOAuthFlow::class, 'Google_Service_DiscoveryEngine_A2aV1ClientCredentialsOAuthFlow');
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1DataPart extends \Google\Model
{
/**
* @var array[]
*/
public $data;
/**
* @param array[] $data
*/
public function setData($data)
{
$this->data = $data;
}
/**
* @return array[]
*/
public function getData()
{
return $this->data;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1DataPart::class, 'Google_Service_DiscoveryEngine_A2aV1DataPart');
@@ -0,0 +1,98 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1FilePart extends \Google\Model
{
/**
* @var string
*/
public $fileWithBytes;
/**
* @var string
*/
public $fileWithUri;
/**
* @var string
*/
public $mimeType;
/**
* @var string
*/
public $name;
/**
* @param string $fileWithBytes
*/
public function setFileWithBytes($fileWithBytes)
{
$this->fileWithBytes = $fileWithBytes;
}
/**
* @return string
*/
public function getFileWithBytes()
{
return $this->fileWithBytes;
}
/**
* @param string $fileWithUri
*/
public function setFileWithUri($fileWithUri)
{
$this->fileWithUri = $fileWithUri;
}
/**
* @return string
*/
public function getFileWithUri()
{
return $this->fileWithUri;
}
/**
* @param string $mimeType
*/
public function setMimeType($mimeType)
{
$this->mimeType = $mimeType;
}
/**
* @return string
*/
public function getMimeType()
{
return $this->mimeType;
}
/**
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1FilePart::class, 'Google_Service_DiscoveryEngine_A2aV1FilePart');
@@ -0,0 +1,102 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1HTTPAuthSecurityScheme extends \Google\Model
{
/**
* A hint to the client to identify how the bearer token is formatted. Bearer
* tokens are usually generated by an authorization server, so this
* information is primarily for documentation purposes.
*
* @var string
*/
public $bearerFormat;
/**
* Description of this security scheme.
*
* @var string
*/
public $description;
/**
* The name of the HTTP Authentication scheme to be used in the Authorization
* header as defined in RFC7235. The values used SHOULD be registered in the
* IANA Authentication Scheme registry. The value is case-insensitive, as
* defined in RFC7235.
*
* @var string
*/
public $scheme;
/**
* A hint to the client to identify how the bearer token is formatted. Bearer
* tokens are usually generated by an authorization server, so this
* information is primarily for documentation purposes.
*
* @param string $bearerFormat
*/
public function setBearerFormat($bearerFormat)
{
$this->bearerFormat = $bearerFormat;
}
/**
* @return string
*/
public function getBearerFormat()
{
return $this->bearerFormat;
}
/**
* Description of this security scheme.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* The name of the HTTP Authentication scheme to be used in the Authorization
* header as defined in RFC7235. The values used SHOULD be registered in the
* IANA Authentication Scheme registry. The value is case-insensitive, as
* defined in RFC7235.
*
* @param string $scheme
*/
public function setScheme($scheme)
{
$this->scheme = $scheme;
}
/**
* @return string
*/
public function getScheme()
{
return $this->scheme;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1HTTPAuthSecurityScheme::class, 'Google_Service_DiscoveryEngine_A2aV1HTTPAuthSecurityScheme');
@@ -0,0 +1,98 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1ImplicitOAuthFlow extends \Google\Model
{
/**
* The authorization URL to be used for this flow. This MUST be in the form of
* a URL. The OAuth2 standard requires the use of TLS
*
* @var string
*/
public $authorizationUrl;
/**
* The URL to be used for obtaining refresh tokens. This MUST be in the form
* of a URL. The OAuth2 standard requires the use of TLS.
*
* @var string
*/
public $refreshUrl;
/**
* The available scopes for the OAuth2 security scheme. A map between the
* scope name and a short description for it. The map MAY be empty.
*
* @var string[]
*/
public $scopes;
/**
* The authorization URL to be used for this flow. This MUST be in the form of
* a URL. The OAuth2 standard requires the use of TLS
*
* @param string $authorizationUrl
*/
public function setAuthorizationUrl($authorizationUrl)
{
$this->authorizationUrl = $authorizationUrl;
}
/**
* @return string
*/
public function getAuthorizationUrl()
{
return $this->authorizationUrl;
}
/**
* The URL to be used for obtaining refresh tokens. This MUST be in the form
* of a URL. The OAuth2 standard requires the use of TLS.
*
* @param string $refreshUrl
*/
public function setRefreshUrl($refreshUrl)
{
$this->refreshUrl = $refreshUrl;
}
/**
* @return string
*/
public function getRefreshUrl()
{
return $this->refreshUrl;
}
/**
* The available scopes for the OAuth2 security scheme. A map between the
* scope name and a short description for it. The map MAY be empty.
*
* @param string[] $scopes
*/
public function setScopes($scopes)
{
$this->scopes = $scopes;
}
/**
* @return string[]
*/
public function getScopes()
{
return $this->scopes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1ImplicitOAuthFlow::class, 'Google_Service_DiscoveryEngine_A2aV1ImplicitOAuthFlow');
@@ -0,0 +1,69 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1ListTaskPushNotificationConfigResponse extends \Google\Collection
{
protected $collection_key = 'configs';
protected $configsType = A2aV1TaskPushNotificationConfig::class;
protected $configsDataType = 'array';
/**
* A token, which can be sent as `page_token` to retrieve the next page. If
* this field is omitted, there are no subsequent pages.
*
* @var string
*/
public $nextPageToken;
/**
* The list of push notification configurations.
*
* @param A2aV1TaskPushNotificationConfig[] $configs
*/
public function setConfigs($configs)
{
$this->configs = $configs;
}
/**
* @return A2aV1TaskPushNotificationConfig[]
*/
public function getConfigs()
{
return $this->configs;
}
/**
* A token, which can be sent as `page_token` to retrieve the next page. If
* this field is omitted, there are no subsequent pages.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1ListTaskPushNotificationConfigResponse::class, 'Google_Service_DiscoveryEngine_A2aV1ListTaskPushNotificationConfigResponse');
@@ -0,0 +1,197 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1Message extends \Google\Collection
{
public const ROLE_ROLE_UNSPECIFIED = 'ROLE_UNSPECIFIED';
/**
* USER role refers to communication from the client to the server.
*/
public const ROLE_ROLE_USER = 'ROLE_USER';
/**
* AGENT role refers to communication from the server to the client.
*/
public const ROLE_ROLE_AGENT = 'ROLE_AGENT';
protected $collection_key = 'extensions';
protected $contentType = A2aV1Part::class;
protected $contentDataType = 'array';
/**
* The context id of the message. This is optional and if set, the message
* will be associated with the given context.
*
* @var string
*/
public $contextId;
/**
* The URIs of extensions that are present or contributed to this Message.
*
* @var string[]
*/
public $extensions;
/**
* The unique identifier (e.g. UUID)of the message. This is required and
* created by the message creator.
*
* @var string
*/
public $messageId;
/**
* protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to
* provide along with the message.
*
* @var array[]
*/
public $metadata;
/**
* A role for the message.
*
* @var string
*/
public $role;
/**
* The task id of the message. This is optional and if set, the message will
* be associated with the given task.
*
* @var string
*/
public $taskId;
/**
* protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container
* of the message content.
*
* @param A2aV1Part[] $content
*/
public function setContent($content)
{
$this->content = $content;
}
/**
* @return A2aV1Part[]
*/
public function getContent()
{
return $this->content;
}
/**
* The context id of the message. This is optional and if set, the message
* will be associated with the given context.
*
* @param string $contextId
*/
public function setContextId($contextId)
{
$this->contextId = $contextId;
}
/**
* @return string
*/
public function getContextId()
{
return $this->contextId;
}
/**
* The URIs of extensions that are present or contributed to this Message.
*
* @param string[] $extensions
*/
public function setExtensions($extensions)
{
$this->extensions = $extensions;
}
/**
* @return string[]
*/
public function getExtensions()
{
return $this->extensions;
}
/**
* The unique identifier (e.g. UUID)of the message. This is required and
* created by the message creator.
*
* @param string $messageId
*/
public function setMessageId($messageId)
{
$this->messageId = $messageId;
}
/**
* @return string
*/
public function getMessageId()
{
return $this->messageId;
}
/**
* protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to
* provide along with the message.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* A role for the message.
*
* Accepted values: ROLE_UNSPECIFIED, ROLE_USER, ROLE_AGENT
*
* @param self::ROLE_* $role
*/
public function setRole($role)
{
$this->role = $role;
}
/**
* @return self::ROLE_*
*/
public function getRole()
{
return $this->role;
}
/**
* The task id of the message. This is optional and if set, the message will
* be associated with the given task.
*
* @param string $taskId
*/
public function setTaskId($taskId)
{
$this->taskId = $taskId;
}
/**
* @return string
*/
public function getTaskId()
{
return $this->taskId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1Message::class, 'Google_Service_DiscoveryEngine_A2aV1Message');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1MutualTlsSecurityScheme extends \Google\Model
{
/**
* Description of this security scheme.
*
* @var string
*/
public $description;
/**
* Description of this security scheme.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1MutualTlsSecurityScheme::class, 'Google_Service_DiscoveryEngine_A2aV1MutualTlsSecurityScheme');
@@ -0,0 +1,90 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1OAuth2SecurityScheme extends \Google\Model
{
/**
* Description of this security scheme.
*
* @var string
*/
public $description;
protected $flowsType = A2aV1OAuthFlows::class;
protected $flowsDataType = '';
/**
* URL to the oauth2 authorization server metadata
* [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
*
* @var string
*/
public $oauth2MetadataUrl;
/**
* Description of this security scheme.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* An object containing configuration information for the flow types supported
*
* @param A2aV1OAuthFlows $flows
*/
public function setFlows(A2aV1OAuthFlows $flows)
{
$this->flows = $flows;
}
/**
* @return A2aV1OAuthFlows
*/
public function getFlows()
{
return $this->flows;
}
/**
* URL to the oauth2 authorization server metadata
* [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
*
* @param string $oauth2MetadataUrl
*/
public function setOauth2MetadataUrl($oauth2MetadataUrl)
{
$this->oauth2MetadataUrl = $oauth2MetadataUrl;
}
/**
* @return string
*/
public function getOauth2MetadataUrl()
{
return $this->oauth2MetadataUrl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1OAuth2SecurityScheme::class, 'Google_Service_DiscoveryEngine_A2aV1OAuth2SecurityScheme');
@@ -0,0 +1,90 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1OAuthFlows extends \Google\Model
{
protected $authorizationCodeType = A2aV1AuthorizationCodeOAuthFlow::class;
protected $authorizationCodeDataType = '';
protected $clientCredentialsType = A2aV1ClientCredentialsOAuthFlow::class;
protected $clientCredentialsDataType = '';
protected $implicitType = A2aV1ImplicitOAuthFlow::class;
protected $implicitDataType = '';
protected $passwordType = A2aV1PasswordOAuthFlow::class;
protected $passwordDataType = '';
/**
* @param A2aV1AuthorizationCodeOAuthFlow $authorizationCode
*/
public function setAuthorizationCode(A2aV1AuthorizationCodeOAuthFlow $authorizationCode)
{
$this->authorizationCode = $authorizationCode;
}
/**
* @return A2aV1AuthorizationCodeOAuthFlow
*/
public function getAuthorizationCode()
{
return $this->authorizationCode;
}
/**
* @param A2aV1ClientCredentialsOAuthFlow $clientCredentials
*/
public function setClientCredentials(A2aV1ClientCredentialsOAuthFlow $clientCredentials)
{
$this->clientCredentials = $clientCredentials;
}
/**
* @return A2aV1ClientCredentialsOAuthFlow
*/
public function getClientCredentials()
{
return $this->clientCredentials;
}
/**
* @param A2aV1ImplicitOAuthFlow $implicit
*/
public function setImplicit(A2aV1ImplicitOAuthFlow $implicit)
{
$this->implicit = $implicit;
}
/**
* @return A2aV1ImplicitOAuthFlow
*/
public function getImplicit()
{
return $this->implicit;
}
/**
* @param A2aV1PasswordOAuthFlow $password
*/
public function setPassword(A2aV1PasswordOAuthFlow $password)
{
$this->password = $password;
}
/**
* @return A2aV1PasswordOAuthFlow
*/
public function getPassword()
{
return $this->password;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1OAuthFlows::class, 'Google_Service_DiscoveryEngine_A2aV1OAuthFlows');
@@ -0,0 +1,72 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1OpenIdConnectSecurityScheme extends \Google\Model
{
/**
* Description of this security scheme.
*
* @var string
*/
public $description;
/**
* Well-known URL to discover the [[OpenID-Connect-Discovery]] provider
* metadata.
*
* @var string
*/
public $openIdConnectUrl;
/**
* Description of this security scheme.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Well-known URL to discover the [[OpenID-Connect-Discovery]] provider
* metadata.
*
* @param string $openIdConnectUrl
*/
public function setOpenIdConnectUrl($openIdConnectUrl)
{
$this->openIdConnectUrl = $openIdConnectUrl;
}
/**
* @return string
*/
public function getOpenIdConnectUrl()
{
return $this->openIdConnectUrl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1OpenIdConnectSecurityScheme::class, 'Google_Service_DiscoveryEngine_A2aV1OpenIdConnectSecurityScheme');
@@ -0,0 +1,98 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1Part extends \Google\Model
{
protected $dataType = A2aV1DataPart::class;
protected $dataDataType = '';
protected $fileType = A2aV1FilePart::class;
protected $fileDataType = '';
/**
* Optional metadata associated with this part.
*
* @var array[]
*/
public $metadata;
/**
* @var string
*/
public $text;
/**
* @param A2aV1DataPart $data
*/
public function setData(A2aV1DataPart $data)
{
$this->data = $data;
}
/**
* @return A2aV1DataPart
*/
public function getData()
{
return $this->data;
}
/**
* @param A2aV1FilePart $file
*/
public function setFile(A2aV1FilePart $file)
{
$this->file = $file;
}
/**
* @return A2aV1FilePart
*/
public function getFile()
{
return $this->file;
}
/**
* Optional metadata associated with this part.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* @param string $text
*/
public function setText($text)
{
$this->text = $text;
}
/**
* @return string
*/
public function getText()
{
return $this->text;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1Part::class, 'Google_Service_DiscoveryEngine_A2aV1Part');
@@ -0,0 +1,98 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1PasswordOAuthFlow extends \Google\Model
{
/**
* The URL to be used for obtaining refresh tokens. This MUST be in the form
* of a URL. The OAuth2 standard requires the use of TLS.
*
* @var string
*/
public $refreshUrl;
/**
* The available scopes for the OAuth2 security scheme. A map between the
* scope name and a short description for it. The map MAY be empty.
*
* @var string[]
*/
public $scopes;
/**
* The token URL to be used for this flow. This MUST be in the form of a URL.
* The OAuth2 standard requires the use of TLS.
*
* @var string
*/
public $tokenUrl;
/**
* The URL to be used for obtaining refresh tokens. This MUST be in the form
* of a URL. The OAuth2 standard requires the use of TLS.
*
* @param string $refreshUrl
*/
public function setRefreshUrl($refreshUrl)
{
$this->refreshUrl = $refreshUrl;
}
/**
* @return string
*/
public function getRefreshUrl()
{
return $this->refreshUrl;
}
/**
* The available scopes for the OAuth2 security scheme. A map between the
* scope name and a short description for it. The map MAY be empty.
*
* @param string[] $scopes
*/
public function setScopes($scopes)
{
$this->scopes = $scopes;
}
/**
* @return string[]
*/
public function getScopes()
{
return $this->scopes;
}
/**
* The token URL to be used for this flow. This MUST be in the form of a URL.
* The OAuth2 standard requires the use of TLS.
*
* @param string $tokenUrl
*/
public function setTokenUrl($tokenUrl)
{
$this->tokenUrl = $tokenUrl;
}
/**
* @return string
*/
public function getTokenUrl()
{
return $this->tokenUrl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1PasswordOAuthFlow::class, 'Google_Service_DiscoveryEngine_A2aV1PasswordOAuthFlow');
@@ -0,0 +1,110 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1PushNotificationConfig extends \Google\Model
{
protected $authenticationType = A2aV1AuthenticationInfo::class;
protected $authenticationDataType = '';
/**
* A unique identifier (e.g. UUID) for this push notification.
*
* @var string
*/
public $id;
/**
* Token unique for this task/session
*
* @var string
*/
public $token;
/**
* Url to send the notification too
*
* @var string
*/
public $url;
/**
* Information about the authentication to sent with the notification
*
* @param A2aV1AuthenticationInfo $authentication
*/
public function setAuthentication(A2aV1AuthenticationInfo $authentication)
{
$this->authentication = $authentication;
}
/**
* @return A2aV1AuthenticationInfo
*/
public function getAuthentication()
{
return $this->authentication;
}
/**
* A unique identifier (e.g. UUID) for this push notification.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Token unique for this task/session
*
* @param string $token
*/
public function setToken($token)
{
$this->token = $token;
}
/**
* @return string
*/
public function getToken()
{
return $this->token;
}
/**
* Url to send the notification too
*
* @param string $url
*/
public function setUrl($url)
{
$this->url = $url;
}
/**
* @return string
*/
public function getUrl()
{
return $this->url;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1PushNotificationConfig::class, 'Google_Service_DiscoveryEngine_A2aV1PushNotificationConfig');
@@ -0,0 +1,42 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1Security extends \Google\Model
{
protected $schemesType = A2aV1StringList::class;
protected $schemesDataType = 'map';
/**
* @param A2aV1StringList[] $schemes
*/
public function setSchemes($schemes)
{
$this->schemes = $schemes;
}
/**
* @return A2aV1StringList[]
*/
public function getSchemes()
{
return $this->schemes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1Security::class, 'Google_Service_DiscoveryEngine_A2aV1Security');
@@ -0,0 +1,106 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1SecurityScheme extends \Google\Model
{
protected $apiKeySecuritySchemeType = A2aV1APIKeySecurityScheme::class;
protected $apiKeySecuritySchemeDataType = '';
protected $httpAuthSecuritySchemeType = A2aV1HTTPAuthSecurityScheme::class;
protected $httpAuthSecuritySchemeDataType = '';
protected $mtlsSecuritySchemeType = A2aV1MutualTlsSecurityScheme::class;
protected $mtlsSecuritySchemeDataType = '';
protected $oauth2SecuritySchemeType = A2aV1OAuth2SecurityScheme::class;
protected $oauth2SecuritySchemeDataType = '';
protected $openIdConnectSecuritySchemeType = A2aV1OpenIdConnectSecurityScheme::class;
protected $openIdConnectSecuritySchemeDataType = '';
/**
* @param A2aV1APIKeySecurityScheme $apiKeySecurityScheme
*/
public function setApiKeySecurityScheme(A2aV1APIKeySecurityScheme $apiKeySecurityScheme)
{
$this->apiKeySecurityScheme = $apiKeySecurityScheme;
}
/**
* @return A2aV1APIKeySecurityScheme
*/
public function getApiKeySecurityScheme()
{
return $this->apiKeySecurityScheme;
}
/**
* @param A2aV1HTTPAuthSecurityScheme $httpAuthSecurityScheme
*/
public function setHttpAuthSecurityScheme(A2aV1HTTPAuthSecurityScheme $httpAuthSecurityScheme)
{
$this->httpAuthSecurityScheme = $httpAuthSecurityScheme;
}
/**
* @return A2aV1HTTPAuthSecurityScheme
*/
public function getHttpAuthSecurityScheme()
{
return $this->httpAuthSecurityScheme;
}
/**
* @param A2aV1MutualTlsSecurityScheme $mtlsSecurityScheme
*/
public function setMtlsSecurityScheme(A2aV1MutualTlsSecurityScheme $mtlsSecurityScheme)
{
$this->mtlsSecurityScheme = $mtlsSecurityScheme;
}
/**
* @return A2aV1MutualTlsSecurityScheme
*/
public function getMtlsSecurityScheme()
{
return $this->mtlsSecurityScheme;
}
/**
* @param A2aV1OAuth2SecurityScheme $oauth2SecurityScheme
*/
public function setOauth2SecurityScheme(A2aV1OAuth2SecurityScheme $oauth2SecurityScheme)
{
$this->oauth2SecurityScheme = $oauth2SecurityScheme;
}
/**
* @return A2aV1OAuth2SecurityScheme
*/
public function getOauth2SecurityScheme()
{
return $this->oauth2SecurityScheme;
}
/**
* @param A2aV1OpenIdConnectSecurityScheme $openIdConnectSecurityScheme
*/
public function setOpenIdConnectSecurityScheme(A2aV1OpenIdConnectSecurityScheme $openIdConnectSecurityScheme)
{
$this->openIdConnectSecurityScheme = $openIdConnectSecurityScheme;
}
/**
* @return A2aV1OpenIdConnectSecurityScheme
*/
public function getOpenIdConnectSecurityScheme()
{
return $this->openIdConnectSecurityScheme;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1SecurityScheme::class, 'Google_Service_DiscoveryEngine_A2aV1SecurityScheme');
@@ -0,0 +1,119 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1SendMessageConfiguration extends \Google\Collection
{
protected $collection_key = 'acceptedOutputModes';
/**
* The output modes that the agent is expected to respond with.
*
* @var string[]
*/
public $acceptedOutputModes;
/**
* If true, the message will be blocking until the task is completed. If
* false, the message will be non-blocking and the task will be returned
* immediately. It is the caller's responsibility to check for any task
* updates.
*
* @var bool
*/
public $blocking;
/**
* The maximum number of messages to include in the history. if 0, the history
* will be unlimited.
*
* @var int
*/
public $historyLength;
protected $pushNotificationType = A2aV1PushNotificationConfig::class;
protected $pushNotificationDataType = '';
/**
* The output modes that the agent is expected to respond with.
*
* @param string[] $acceptedOutputModes
*/
public function setAcceptedOutputModes($acceptedOutputModes)
{
$this->acceptedOutputModes = $acceptedOutputModes;
}
/**
* @return string[]
*/
public function getAcceptedOutputModes()
{
return $this->acceptedOutputModes;
}
/**
* If true, the message will be blocking until the task is completed. If
* false, the message will be non-blocking and the task will be returned
* immediately. It is the caller's responsibility to check for any task
* updates.
*
* @param bool $blocking
*/
public function setBlocking($blocking)
{
$this->blocking = $blocking;
}
/**
* @return bool
*/
public function getBlocking()
{
return $this->blocking;
}
/**
* The maximum number of messages to include in the history. if 0, the history
* will be unlimited.
*
* @param int $historyLength
*/
public function setHistoryLength($historyLength)
{
$this->historyLength = $historyLength;
}
/**
* @return int
*/
public function getHistoryLength()
{
return $this->historyLength;
}
/**
* A configuration of a webhook that can be used to receive updates
*
* @param A2aV1PushNotificationConfig $pushNotification
*/
public function setPushNotification(A2aV1PushNotificationConfig $pushNotification)
{
$this->pushNotification = $pushNotification;
}
/**
* @return A2aV1PushNotificationConfig
*/
public function getPushNotification()
{
return $this->pushNotification;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1SendMessageConfiguration::class, 'Google_Service_DiscoveryEngine_A2aV1SendMessageConfiguration');
@@ -0,0 +1,84 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1SendMessageRequest extends \Google\Model
{
protected $configurationType = A2aV1SendMessageConfiguration::class;
protected $configurationDataType = '';
protected $messageType = A2aV1Message::class;
protected $messageDataType = '';
/**
* Optional metadata for the request.
*
* @var array[]
*/
public $metadata;
/**
* Configuration for the send request.
*
* @param A2aV1SendMessageConfiguration $configuration
*/
public function setConfiguration(A2aV1SendMessageConfiguration $configuration)
{
$this->configuration = $configuration;
}
/**
* @return A2aV1SendMessageConfiguration
*/
public function getConfiguration()
{
return $this->configuration;
}
/**
* Required. The message to send to the agent.
*
* @param A2aV1Message $message
*/
public function setMessage(A2aV1Message $message)
{
$this->message = $message;
}
/**
* @return A2aV1Message
*/
public function getMessage()
{
return $this->message;
}
/**
* Optional metadata for the request.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1SendMessageRequest::class, 'Google_Service_DiscoveryEngine_A2aV1SendMessageRequest');
@@ -0,0 +1,58 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1SendMessageResponse extends \Google\Model
{
protected $messageType = A2aV1Message::class;
protected $messageDataType = '';
protected $taskType = A2aV1Task::class;
protected $taskDataType = '';
/**
* @param A2aV1Message $message
*/
public function setMessage(A2aV1Message $message)
{
$this->message = $message;
}
/**
* @return A2aV1Message
*/
public function getMessage()
{
return $this->message;
}
/**
* @param A2aV1Task $task
*/
public function setTask(A2aV1Task $task)
{
$this->task = $task;
}
/**
* @return A2aV1Task
*/
public function getTask()
{
return $this->task;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1SendMessageResponse::class, 'Google_Service_DiscoveryEngine_A2aV1SendMessageResponse');
@@ -0,0 +1,90 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1StreamResponse extends \Google\Model
{
protected $artifactUpdateType = A2aV1TaskArtifactUpdateEvent::class;
protected $artifactUpdateDataType = '';
protected $messageType = A2aV1Message::class;
protected $messageDataType = '';
protected $statusUpdateType = A2aV1TaskStatusUpdateEvent::class;
protected $statusUpdateDataType = '';
protected $taskType = A2aV1Task::class;
protected $taskDataType = '';
/**
* @param A2aV1TaskArtifactUpdateEvent $artifactUpdate
*/
public function setArtifactUpdate(A2aV1TaskArtifactUpdateEvent $artifactUpdate)
{
$this->artifactUpdate = $artifactUpdate;
}
/**
* @return A2aV1TaskArtifactUpdateEvent
*/
public function getArtifactUpdate()
{
return $this->artifactUpdate;
}
/**
* @param A2aV1Message $message
*/
public function setMessage(A2aV1Message $message)
{
$this->message = $message;
}
/**
* @return A2aV1Message
*/
public function getMessage()
{
return $this->message;
}
/**
* @param A2aV1TaskStatusUpdateEvent $statusUpdate
*/
public function setStatusUpdate(A2aV1TaskStatusUpdateEvent $statusUpdate)
{
$this->statusUpdate = $statusUpdate;
}
/**
* @return A2aV1TaskStatusUpdateEvent
*/
public function getStatusUpdate()
{
return $this->statusUpdate;
}
/**
* @param A2aV1Task $task
*/
public function setTask(A2aV1Task $task)
{
$this->task = $task;
}
/**
* @return A2aV1Task
*/
public function getTask()
{
return $this->task;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1StreamResponse::class, 'Google_Service_DiscoveryEngine_A2aV1StreamResponse');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1StringList extends \Google\Collection
{
protected $collection_key = 'list';
/**
* @var string[]
*/
public $list;
/**
* @param string[] $list
*/
public function setList($list)
{
$this->list = $list;
}
/**
* @return string[]
*/
public function getList()
{
return $this->list;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1StringList::class, 'Google_Service_DiscoveryEngine_A2aV1StringList');
@@ -0,0 +1,154 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1Task extends \Google\Collection
{
protected $collection_key = 'history';
protected $artifactsType = A2aV1Artifact::class;
protected $artifactsDataType = 'array';
/**
* Unique identifier (e.g. UUID) for the contextual collection of interactions
* (tasks and messages). Created by the A2A server.
*
* @var string
*/
public $contextId;
protected $historyType = A2aV1Message::class;
protected $historyDataType = 'array';
/**
* Unique identifier (e.g. UUID) for the task, generated by the server for a
* new task.
*
* @var string
*/
public $id;
/**
* protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to
* store custom metadata about a task.
*
* @var array[]
*/
public $metadata;
protected $statusType = A2aV1TaskStatus::class;
protected $statusDataType = '';
/**
* A set of output artifacts for a Task.
*
* @param A2aV1Artifact[] $artifacts
*/
public function setArtifacts($artifacts)
{
$this->artifacts = $artifacts;
}
/**
* @return A2aV1Artifact[]
*/
public function getArtifacts()
{
return $this->artifacts;
}
/**
* Unique identifier (e.g. UUID) for the contextual collection of interactions
* (tasks and messages). Created by the A2A server.
*
* @param string $contextId
*/
public function setContextId($contextId)
{
$this->contextId = $contextId;
}
/**
* @return string
*/
public function getContextId()
{
return $this->contextId;
}
/**
* protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of
* interactions from a task.
*
* @param A2aV1Message[] $history
*/
public function setHistory($history)
{
$this->history = $history;
}
/**
* @return A2aV1Message[]
*/
public function getHistory()
{
return $this->history;
}
/**
* Unique identifier (e.g. UUID) for the task, generated by the server for a
* new task.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to
* store custom metadata about a task.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* The current status of a Task, including state and a message.
*
* @param A2aV1TaskStatus $status
*/
public function setStatus(A2aV1TaskStatus $status)
{
$this->status = $status;
}
/**
* @return A2aV1TaskStatus
*/
public function getStatus()
{
return $this->status;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1Task::class, 'Google_Service_DiscoveryEngine_A2aV1Task');
@@ -0,0 +1,154 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1TaskArtifactUpdateEvent extends \Google\Model
{
/**
* Whether this should be appended to a prior one produced
*
* @var bool
*/
public $append;
protected $artifactType = A2aV1Artifact::class;
protected $artifactDataType = '';
/**
* The id of the context that this task belongs too
*
* @var string
*/
public $contextId;
/**
* Whether this represents the last part of an artifact
*
* @var bool
*/
public $lastChunk;
/**
* Optional metadata associated with the artifact update.
*
* @var array[]
*/
public $metadata;
/**
* The id of the task for this artifact
*
* @var string
*/
public $taskId;
/**
* Whether this should be appended to a prior one produced
*
* @param bool $append
*/
public function setAppend($append)
{
$this->append = $append;
}
/**
* @return bool
*/
public function getAppend()
{
return $this->append;
}
/**
* The artifact itself
*
* @param A2aV1Artifact $artifact
*/
public function setArtifact(A2aV1Artifact $artifact)
{
$this->artifact = $artifact;
}
/**
* @return A2aV1Artifact
*/
public function getArtifact()
{
return $this->artifact;
}
/**
* The id of the context that this task belongs too
*
* @param string $contextId
*/
public function setContextId($contextId)
{
$this->contextId = $contextId;
}
/**
* @return string
*/
public function getContextId()
{
return $this->contextId;
}
/**
* Whether this represents the last part of an artifact
*
* @param bool $lastChunk
*/
public function setLastChunk($lastChunk)
{
$this->lastChunk = $lastChunk;
}
/**
* @return bool
*/
public function getLastChunk()
{
return $this->lastChunk;
}
/**
* Optional metadata associated with the artifact update.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* The id of the task for this artifact
*
* @param string $taskId
*/
public function setTaskId($taskId)
{
$this->taskId = $taskId;
}
/**
* @return string
*/
public function getTaskId()
{
return $this->taskId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1TaskArtifactUpdateEvent::class, 'Google_Service_DiscoveryEngine_A2aV1TaskArtifactUpdateEvent');
@@ -0,0 +1,68 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1TaskPushNotificationConfig extends \Google\Model
{
/**
* The resource name of the config. Format:
* tasks/{task_id}/pushNotificationConfigs/{config_id}
*
* @var string
*/
public $name;
protected $pushNotificationConfigType = A2aV1PushNotificationConfig::class;
protected $pushNotificationConfigDataType = '';
/**
* The resource name of the config. Format:
* tasks/{task_id}/pushNotificationConfigs/{config_id}
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The push notification configuration details.
*
* @param A2aV1PushNotificationConfig $pushNotificationConfig
*/
public function setPushNotificationConfig(A2aV1PushNotificationConfig $pushNotificationConfig)
{
$this->pushNotificationConfig = $pushNotificationConfig;
}
/**
* @return A2aV1PushNotificationConfig
*/
public function getPushNotificationConfig()
{
return $this->pushNotificationConfig;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1TaskPushNotificationConfig::class, 'Google_Service_DiscoveryEngine_A2aV1TaskPushNotificationConfig');
@@ -0,0 +1,132 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1TaskStatus extends \Google\Model
{
public const STATE_TASK_STATE_UNSPECIFIED = 'TASK_STATE_UNSPECIFIED';
/**
* Represents the status that acknowledges a task is created
*/
public const STATE_TASK_STATE_SUBMITTED = 'TASK_STATE_SUBMITTED';
/**
* Represents the status that a task is actively being processed
*/
public const STATE_TASK_STATE_WORKING = 'TASK_STATE_WORKING';
/**
* Represents the status a task is finished. This is a terminal state
*/
public const STATE_TASK_STATE_COMPLETED = 'TASK_STATE_COMPLETED';
/**
* Represents the status a task is done but failed. This is a terminal state
*/
public const STATE_TASK_STATE_FAILED = 'TASK_STATE_FAILED';
/**
* Represents the status a task was cancelled before it finished. This is a
* terminal state.
*/
public const STATE_TASK_STATE_CANCELLED = 'TASK_STATE_CANCELLED';
/**
* Represents the status that the task requires information to complete. This
* is an interrupted state.
*/
public const STATE_TASK_STATE_INPUT_REQUIRED = 'TASK_STATE_INPUT_REQUIRED';
/**
* Represents the status that the agent has decided to not perform the task.
* This may be done during initial task creation or later once an agent has
* determined it can't or won't proceed. This is a terminal state.
*/
public const STATE_TASK_STATE_REJECTED = 'TASK_STATE_REJECTED';
/**
* Represents the state that some authentication is needed from the upstream
* client. Authentication is expected to come out-of-band thus this is not an
* interrupted or terminal state.
*/
public const STATE_TASK_STATE_AUTH_REQUIRED = 'TASK_STATE_AUTH_REQUIRED';
protected $messageType = A2aV1Message::class;
protected $messageDataType = '';
/**
* The current state of this task
*
* @var string
*/
public $state;
/**
* Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
*
* @var string
*/
public $timestamp;
/**
* A message associated with the status.
*
* @param A2aV1Message $message
*/
public function setMessage(A2aV1Message $message)
{
$this->message = $message;
}
/**
* @return A2aV1Message
*/
public function getMessage()
{
return $this->message;
}
/**
* The current state of this task
*
* Accepted values: TASK_STATE_UNSPECIFIED, TASK_STATE_SUBMITTED,
* TASK_STATE_WORKING, TASK_STATE_COMPLETED, TASK_STATE_FAILED,
* TASK_STATE_CANCELLED, TASK_STATE_INPUT_REQUIRED, TASK_STATE_REJECTED,
* TASK_STATE_AUTH_REQUIRED
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
*
* @param string $timestamp
*/
public function setTimestamp($timestamp)
{
$this->timestamp = $timestamp;
}
/**
* @return string
*/
public function getTimestamp()
{
return $this->timestamp;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1TaskStatus::class, 'Google_Service_DiscoveryEngine_A2aV1TaskStatus');
@@ -0,0 +1,132 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class A2aV1TaskStatusUpdateEvent extends \Google\Model
{
/**
* The id of the context that the task belongs to
*
* @var string
*/
public $contextId;
/**
* Whether this is the last status update expected for this task.
*
* @var bool
*/
public $final;
/**
* Optional metadata to associate with the task update.
*
* @var array[]
*/
public $metadata;
protected $statusType = A2aV1TaskStatus::class;
protected $statusDataType = '';
/**
* The id of the task that is changed
*
* @var string
*/
public $taskId;
/**
* The id of the context that the task belongs to
*
* @param string $contextId
*/
public function setContextId($contextId)
{
$this->contextId = $contextId;
}
/**
* @return string
*/
public function getContextId()
{
return $this->contextId;
}
/**
* Whether this is the last status update expected for this task.
*
* @param bool $final
*/
public function setFinal($final)
{
$this->final = $final;
}
/**
* @return bool
*/
public function getFinal()
{
return $this->final;
}
/**
* Optional metadata to associate with the task update.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* The new status of the task.
*
* @param A2aV1TaskStatus $status
*/
public function setStatus(A2aV1TaskStatus $status)
{
$this->status = $status;
}
/**
* @return A2aV1TaskStatus
*/
public function getStatus()
{
return $this->status;
}
/**
* The id of the task that is changed
*
* @param string $taskId
*/
public function setTaskId($taskId)
{
$this->taskId = $taskId;
}
/**
* @return string
*/
public function getTaskId()
{
return $this->taskId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(A2aV1TaskStatusUpdateEvent::class, 'Google_Service_DiscoveryEngine_A2aV1TaskStatusUpdateEvent');
@@ -0,0 +1,148 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataBlobstore2Info extends \Google\Model
{
/**
* The blob generation id.
*
* @var string
*/
public $blobGeneration;
/**
* The blob id, e.g., /blobstore/prod/playground/scotty
*
* @var string
*/
public $blobId;
/**
* Read handle passed from Bigstore -> Scotty for a GCS download. This is a
* signed, serialized blobstore2.ReadHandle proto which must never be set
* outside of Bigstore, and is not applicable to non-GCS media downloads.
*
* @var string
*/
public $downloadReadHandle;
/**
* The blob read token. Needed to read blobs that have not been replicated.
* Might not be available until the final call.
*
* @var string
*/
public $readToken;
/**
* Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a
* signed, serialized blobstore2.BlobMetadataContainer proto which must never
* be consumed outside of Bigstore, and is not applicable to non-GCS media
* uploads.
*
* @var string
*/
public $uploadMetadataContainer;
/**
* The blob generation id.
*
* @param string $blobGeneration
*/
public function setBlobGeneration($blobGeneration)
{
$this->blobGeneration = $blobGeneration;
}
/**
* @return string
*/
public function getBlobGeneration()
{
return $this->blobGeneration;
}
/**
* The blob id, e.g., /blobstore/prod/playground/scotty
*
* @param string $blobId
*/
public function setBlobId($blobId)
{
$this->blobId = $blobId;
}
/**
* @return string
*/
public function getBlobId()
{
return $this->blobId;
}
/**
* Read handle passed from Bigstore -> Scotty for a GCS download. This is a
* signed, serialized blobstore2.ReadHandle proto which must never be set
* outside of Bigstore, and is not applicable to non-GCS media downloads.
*
* @param string $downloadReadHandle
*/
public function setDownloadReadHandle($downloadReadHandle)
{
$this->downloadReadHandle = $downloadReadHandle;
}
/**
* @return string
*/
public function getDownloadReadHandle()
{
return $this->downloadReadHandle;
}
/**
* The blob read token. Needed to read blobs that have not been replicated.
* Might not be available until the final call.
*
* @param string $readToken
*/
public function setReadToken($readToken)
{
$this->readToken = $readToken;
}
/**
* @return string
*/
public function getReadToken()
{
return $this->readToken;
}
/**
* Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a
* signed, serialized blobstore2.BlobMetadataContainer proto which must never
* be consumed outside of Bigstore, and is not applicable to non-GCS media
* uploads.
*
* @param string $uploadMetadataContainer
*/
public function setUploadMetadataContainer($uploadMetadataContainer)
{
$this->uploadMetadataContainer = $uploadMetadataContainer;
}
/**
* @return string
*/
public function getUploadMetadataContainer()
{
return $this->uploadMetadataContainer;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataBlobstore2Info::class, 'Google_Service_DiscoveryEngine_GdataBlobstore2Info');
@@ -0,0 +1,305 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataCompositeMedia extends \Google\Model
{
/**
* Reference contains a GFS path or a local path.
*/
public const REFERENCE_TYPE_PATH = 'PATH';
/**
* Reference points to a blobstore object. This could be either a v1 blob_ref
* or a v2 blobstore2_info. Clients should check blobstore2_info first, since
* v1 is being deprecated.
*/
public const REFERENCE_TYPE_BLOB_REF = 'BLOB_REF';
/**
* Data is included into this proto buffer
*/
public const REFERENCE_TYPE_INLINE = 'INLINE';
/**
* Reference points to a bigstore object
*/
public const REFERENCE_TYPE_BIGSTORE_REF = 'BIGSTORE_REF';
/**
* Indicates the data is stored in cosmo_binary_reference.
*/
public const REFERENCE_TYPE_COSMO_BINARY_REFERENCE = 'COSMO_BINARY_REFERENCE';
/**
* Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should
* be the byte representation of a blobstore.BlobRef. Since Blobstore is
* deprecating v1, use blobstore2_info instead. For now, any v2 blob will also
* be represented in this field as v1 BlobRef.
*
* @deprecated
* @var string
*/
public $blobRef;
protected $blobstore2InfoType = GdataBlobstore2Info::class;
protected $blobstore2InfoDataType = '';
/**
* A binary data reference for a media download. Serves as a technology-
* agnostic binary reference in some Google infrastructure. This value is a
* serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a
* hack to get around the fact that the cosmo proto (as well as others it
* includes) doesn't support JavaScript. This prevents us from including the
* actual type of this field.
*
* @var string
*/
public $cosmoBinaryReference;
/**
* crc32.c hash for the payload.
*
* @var string
*/
public $crc32cHash;
/**
* Media data, set if reference_type is INLINE
*
* @var string
*/
public $inline;
/**
* Size of the data, in bytes
*
* @var string
*/
public $length;
/**
* MD5 hash for the payload.
*
* @var string
*/
public $md5Hash;
protected $objectIdType = GdataObjectId::class;
protected $objectIdDataType = '';
/**
* Path to the data, set if reference_type is PATH
*
* @var string
*/
public $path;
/**
* Describes what the field reference contains.
*
* @var string
*/
public $referenceType;
/**
* SHA-1 hash for the payload.
*
* @var string
*/
public $sha1Hash;
/**
* Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should
* be the byte representation of a blobstore.BlobRef. Since Blobstore is
* deprecating v1, use blobstore2_info instead. For now, any v2 blob will also
* be represented in this field as v1 BlobRef.
*
* @deprecated
* @param string $blobRef
*/
public function setBlobRef($blobRef)
{
$this->blobRef = $blobRef;
}
/**
* @deprecated
* @return string
*/
public function getBlobRef()
{
return $this->blobRef;
}
/**
* Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to
* a v2 blob.
*
* @param GdataBlobstore2Info $blobstore2Info
*/
public function setBlobstore2Info(GdataBlobstore2Info $blobstore2Info)
{
$this->blobstore2Info = $blobstore2Info;
}
/**
* @return GdataBlobstore2Info
*/
public function getBlobstore2Info()
{
return $this->blobstore2Info;
}
/**
* A binary data reference for a media download. Serves as a technology-
* agnostic binary reference in some Google infrastructure. This value is a
* serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a
* hack to get around the fact that the cosmo proto (as well as others it
* includes) doesn't support JavaScript. This prevents us from including the
* actual type of this field.
*
* @param string $cosmoBinaryReference
*/
public function setCosmoBinaryReference($cosmoBinaryReference)
{
$this->cosmoBinaryReference = $cosmoBinaryReference;
}
/**
* @return string
*/
public function getCosmoBinaryReference()
{
return $this->cosmoBinaryReference;
}
/**
* crc32.c hash for the payload.
*
* @param string $crc32cHash
*/
public function setCrc32cHash($crc32cHash)
{
$this->crc32cHash = $crc32cHash;
}
/**
* @return string
*/
public function getCrc32cHash()
{
return $this->crc32cHash;
}
/**
* Media data, set if reference_type is INLINE
*
* @param string $inline
*/
public function setInline($inline)
{
$this->inline = $inline;
}
/**
* @return string
*/
public function getInline()
{
return $this->inline;
}
/**
* Size of the data, in bytes
*
* @param string $length
*/
public function setLength($length)
{
$this->length = $length;
}
/**
* @return string
*/
public function getLength()
{
return $this->length;
}
/**
* MD5 hash for the payload.
*
* @param string $md5Hash
*/
public function setMd5Hash($md5Hash)
{
$this->md5Hash = $md5Hash;
}
/**
* @return string
*/
public function getMd5Hash()
{
return $this->md5Hash;
}
/**
* Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
*
* @param GdataObjectId $objectId
*/
public function setObjectId(GdataObjectId $objectId)
{
$this->objectId = $objectId;
}
/**
* @return GdataObjectId
*/
public function getObjectId()
{
return $this->objectId;
}
/**
* Path to the data, set if reference_type is PATH
*
* @param string $path
*/
public function setPath($path)
{
$this->path = $path;
}
/**
* @return string
*/
public function getPath()
{
return $this->path;
}
/**
* Describes what the field reference contains.
*
* Accepted values: PATH, BLOB_REF, INLINE, BIGSTORE_REF,
* COSMO_BINARY_REFERENCE
*
* @param self::REFERENCE_TYPE_* $referenceType
*/
public function setReferenceType($referenceType)
{
$this->referenceType = $referenceType;
}
/**
* @return self::REFERENCE_TYPE_*
*/
public function getReferenceType()
{
return $this->referenceType;
}
/**
* SHA-1 hash for the payload.
*
* @param string $sha1Hash
*/
public function setSha1Hash($sha1Hash)
{
$this->sha1Hash = $sha1Hash;
}
/**
* @return string
*/
public function getSha1Hash()
{
return $this->sha1Hash;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataCompositeMedia::class, 'Google_Service_DiscoveryEngine_GdataCompositeMedia');
@@ -0,0 +1,146 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataContentTypeInfo extends \Google\Model
{
/**
* Scotty's best guess of what the content type of the file is.
*
* @var string
*/
public $bestGuess;
/**
* The content type of the file derived by looking at specific bytes (i.e.
* "magic bytes") of the actual file.
*
* @var string
*/
public $fromBytes;
/**
* The content type of the file derived from the file extension of the
* original file name used by the client.
*
* @var string
*/
public $fromFileName;
/**
* The content type of the file as specified in the request headers, multipart
* headers, or RUPIO start request.
*
* @var string
*/
public $fromHeader;
/**
* The content type of the file derived from the file extension of the URL
* path. The URL path is assumed to represent a file name (which is typically
* only true for agents that are providing a REST API).
*
* @var string
*/
public $fromUrlPath;
/**
* Scotty's best guess of what the content type of the file is.
*
* @param string $bestGuess
*/
public function setBestGuess($bestGuess)
{
$this->bestGuess = $bestGuess;
}
/**
* @return string
*/
public function getBestGuess()
{
return $this->bestGuess;
}
/**
* The content type of the file derived by looking at specific bytes (i.e.
* "magic bytes") of the actual file.
*
* @param string $fromBytes
*/
public function setFromBytes($fromBytes)
{
$this->fromBytes = $fromBytes;
}
/**
* @return string
*/
public function getFromBytes()
{
return $this->fromBytes;
}
/**
* The content type of the file derived from the file extension of the
* original file name used by the client.
*
* @param string $fromFileName
*/
public function setFromFileName($fromFileName)
{
$this->fromFileName = $fromFileName;
}
/**
* @return string
*/
public function getFromFileName()
{
return $this->fromFileName;
}
/**
* The content type of the file as specified in the request headers, multipart
* headers, or RUPIO start request.
*
* @param string $fromHeader
*/
public function setFromHeader($fromHeader)
{
$this->fromHeader = $fromHeader;
}
/**
* @return string
*/
public function getFromHeader()
{
return $this->fromHeader;
}
/**
* The content type of the file derived from the file extension of the URL
* path. The URL path is assumed to represent a file name (which is typically
* only true for agents that are providing a REST API).
*
* @param string $fromUrlPath
*/
public function setFromUrlPath($fromUrlPath)
{
$this->fromUrlPath = $fromUrlPath;
}
/**
* @return string
*/
public function getFromUrlPath()
{
return $this->fromUrlPath;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataContentTypeInfo::class, 'Google_Service_DiscoveryEngine_GdataContentTypeInfo');
@@ -0,0 +1,133 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataDiffChecksumsResponse extends \Google\Model
{
protected $checksumsLocationType = GdataCompositeMedia::class;
protected $checksumsLocationDataType = '';
/**
* The chunk size of checksums. Must be a multiple of 256KB.
*
* @var string
*/
public $chunkSizeBytes;
protected $objectLocationType = GdataCompositeMedia::class;
protected $objectLocationDataType = '';
/**
* The total size of the server object.
*
* @var string
*/
public $objectSizeBytes;
/**
* The object version of the object the checksums are being returned for.
*
* @var string
*/
public $objectVersion;
/**
* Exactly one of these fields must be populated. If checksums_location is
* filled, the server will return the corresponding contents to the user. If
* object_location is filled, the server will calculate the checksums based on
* the content there and return that to the user. For details on the format of
* the checksums, see http://go/scotty-diff-protocol.
*
* @param GdataCompositeMedia $checksumsLocation
*/
public function setChecksumsLocation(GdataCompositeMedia $checksumsLocation)
{
$this->checksumsLocation = $checksumsLocation;
}
/**
* @return GdataCompositeMedia
*/
public function getChecksumsLocation()
{
return $this->checksumsLocation;
}
/**
* The chunk size of checksums. Must be a multiple of 256KB.
*
* @param string $chunkSizeBytes
*/
public function setChunkSizeBytes($chunkSizeBytes)
{
$this->chunkSizeBytes = $chunkSizeBytes;
}
/**
* @return string
*/
public function getChunkSizeBytes()
{
return $this->chunkSizeBytes;
}
/**
* If set, calculate the checksums based on the contents and return them to
* the caller.
*
* @param GdataCompositeMedia $objectLocation
*/
public function setObjectLocation(GdataCompositeMedia $objectLocation)
{
$this->objectLocation = $objectLocation;
}
/**
* @return GdataCompositeMedia
*/
public function getObjectLocation()
{
return $this->objectLocation;
}
/**
* The total size of the server object.
*
* @param string $objectSizeBytes
*/
public function setObjectSizeBytes($objectSizeBytes)
{
$this->objectSizeBytes = $objectSizeBytes;
}
/**
* @return string
*/
public function getObjectSizeBytes()
{
return $this->objectSizeBytes;
}
/**
* The object version of the object the checksums are being returned for.
*
* @param string $objectVersion
*/
public function setObjectVersion($objectVersion)
{
$this->objectVersion = $objectVersion;
}
/**
* @return string
*/
public function getObjectVersion()
{
return $this->objectVersion;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataDiffChecksumsResponse::class, 'Google_Service_DiscoveryEngine_GdataDiffChecksumsResponse');
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataDiffDownloadResponse extends \Google\Model
{
protected $objectLocationType = GdataCompositeMedia::class;
protected $objectLocationDataType = '';
/**
* The original object location.
*
* @param GdataCompositeMedia $objectLocation
*/
public function setObjectLocation(GdataCompositeMedia $objectLocation)
{
$this->objectLocation = $objectLocation;
}
/**
* @return GdataCompositeMedia
*/
public function getObjectLocation()
{
return $this->objectLocation;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataDiffDownloadResponse::class, 'Google_Service_DiscoveryEngine_GdataDiffDownloadResponse');
@@ -0,0 +1,90 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataDiffUploadRequest extends \Google\Model
{
protected $checksumsInfoType = GdataCompositeMedia::class;
protected $checksumsInfoDataType = '';
protected $objectInfoType = GdataCompositeMedia::class;
protected $objectInfoDataType = '';
/**
* The object version of the object that is the base version the incoming diff
* script will be applied to. This field will always be filled in.
*
* @var string
*/
public $objectVersion;
/**
* The location of the checksums for the new object. Agents must clone the
* object located here, as the upload server will delete the contents once a
* response is received. For details on the format of the checksums, see
* http://go/scotty-diff-protocol.
*
* @param GdataCompositeMedia $checksumsInfo
*/
public function setChecksumsInfo(GdataCompositeMedia $checksumsInfo)
{
$this->checksumsInfo = $checksumsInfo;
}
/**
* @return GdataCompositeMedia
*/
public function getChecksumsInfo()
{
return $this->checksumsInfo;
}
/**
* The location of the new object. Agents must clone the object located here,
* as the upload server will delete the contents once a response is received.
*
* @param GdataCompositeMedia $objectInfo
*/
public function setObjectInfo(GdataCompositeMedia $objectInfo)
{
$this->objectInfo = $objectInfo;
}
/**
* @return GdataCompositeMedia
*/
public function getObjectInfo()
{
return $this->objectInfo;
}
/**
* The object version of the object that is the base version the incoming diff
* script will be applied to. This field will always be filled in.
*
* @param string $objectVersion
*/
public function setObjectVersion($objectVersion)
{
$this->objectVersion = $objectVersion;
}
/**
* @return string
*/
public function getObjectVersion()
{
return $this->objectVersion;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataDiffUploadRequest::class, 'Google_Service_DiscoveryEngine_GdataDiffUploadRequest');
@@ -0,0 +1,73 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataDiffUploadResponse extends \Google\Model
{
/**
* The object version of the object at the server. Must be included in the end
* notification response. The version in the end notification response must
* correspond to the new version of the object that is now stored at the
* server, after the upload.
*
* @var string
*/
public $objectVersion;
protected $originalObjectType = GdataCompositeMedia::class;
protected $originalObjectDataType = '';
/**
* The object version of the object at the server. Must be included in the end
* notification response. The version in the end notification response must
* correspond to the new version of the object that is now stored at the
* server, after the upload.
*
* @param string $objectVersion
*/
public function setObjectVersion($objectVersion)
{
$this->objectVersion = $objectVersion;
}
/**
* @return string
*/
public function getObjectVersion()
{
return $this->objectVersion;
}
/**
* The location of the original file for a diff upload request. Must be filled
* in if responding to an upload start notification.
*
* @param GdataCompositeMedia $originalObject
*/
public function setOriginalObject(GdataCompositeMedia $originalObject)
{
$this->originalObject = $originalObject;
}
/**
* @return GdataCompositeMedia
*/
public function getOriginalObject()
{
return $this->originalObject;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataDiffUploadResponse::class, 'Google_Service_DiscoveryEngine_GdataDiffUploadResponse');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataDiffVersionResponse extends \Google\Model
{
/**
* The total size of the server object.
*
* @var string
*/
public $objectSizeBytes;
/**
* The version of the object stored at the server.
*
* @var string
*/
public $objectVersion;
/**
* The total size of the server object.
*
* @param string $objectSizeBytes
*/
public function setObjectSizeBytes($objectSizeBytes)
{
$this->objectSizeBytes = $objectSizeBytes;
}
/**
* @return string
*/
public function getObjectSizeBytes()
{
return $this->objectSizeBytes;
}
/**
* The version of the object stored at the server.
*
* @param string $objectVersion
*/
public function setObjectVersion($objectVersion)
{
$this->objectVersion = $objectVersion;
}
/**
* @return string
*/
public function getObjectVersion()
{
return $this->objectVersion;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataDiffVersionResponse::class, 'Google_Service_DiscoveryEngine_GdataDiffVersionResponse');
@@ -0,0 +1,78 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataDownloadParameters extends \Google\Model
{
/**
* A boolean to be returned in the response to Scotty. Allows/disallows gzip
* encoding of the payload content when the server thinks it's advantageous
* (hence, does not guarantee compression) which allows Scotty to GZip the
* response to the client.
*
* @var bool
*/
public $allowGzipCompression;
/**
* Determining whether or not Apiary should skip the inclusion of any Content-
* Range header on its response to Scotty.
*
* @var bool
*/
public $ignoreRange;
/**
* A boolean to be returned in the response to Scotty. Allows/disallows gzip
* encoding of the payload content when the server thinks it's advantageous
* (hence, does not guarantee compression) which allows Scotty to GZip the
* response to the client.
*
* @param bool $allowGzipCompression
*/
public function setAllowGzipCompression($allowGzipCompression)
{
$this->allowGzipCompression = $allowGzipCompression;
}
/**
* @return bool
*/
public function getAllowGzipCompression()
{
return $this->allowGzipCompression;
}
/**
* Determining whether or not Apiary should skip the inclusion of any Content-
* Range header on its response to Scotty.
*
* @param bool $ignoreRange
*/
public function setIgnoreRange($ignoreRange)
{
$this->ignoreRange = $ignoreRange;
}
/**
* @return bool
*/
public function getIgnoreRange()
{
return $this->ignoreRange;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataDownloadParameters::class, 'Google_Service_DiscoveryEngine_GdataDownloadParameters');
@@ -0,0 +1,784 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataMedia extends \Google\Collection
{
/**
* Reference contains a GFS path or a local path.
*/
public const REFERENCE_TYPE_PATH = 'PATH';
/**
* Reference points to a blobstore object. This could be either a v1 blob_ref
* or a v2 blobstore2_info. Clients should check blobstore2_info first, since
* v1 is being deprecated.
*/
public const REFERENCE_TYPE_BLOB_REF = 'BLOB_REF';
/**
* Data is included into this proto buffer
*/
public const REFERENCE_TYPE_INLINE = 'INLINE';
/**
* Data should be accessed from the current service using the operation
* GetMedia.
*/
public const REFERENCE_TYPE_GET_MEDIA = 'GET_MEDIA';
/**
* The content for this media object is stored across multiple partial media
* objects under the composite_media field.
*/
public const REFERENCE_TYPE_COMPOSITE_MEDIA = 'COMPOSITE_MEDIA';
/**
* Reference points to a bigstore object
*/
public const REFERENCE_TYPE_BIGSTORE_REF = 'BIGSTORE_REF';
/**
* Indicates the data is stored in diff_version_response.
*/
public const REFERENCE_TYPE_DIFF_VERSION_RESPONSE = 'DIFF_VERSION_RESPONSE';
/**
* Indicates the data is stored in diff_checksums_response.
*/
public const REFERENCE_TYPE_DIFF_CHECKSUMS_RESPONSE = 'DIFF_CHECKSUMS_RESPONSE';
/**
* Indicates the data is stored in diff_download_response.
*/
public const REFERENCE_TYPE_DIFF_DOWNLOAD_RESPONSE = 'DIFF_DOWNLOAD_RESPONSE';
/**
* Indicates the data is stored in diff_upload_request.
*/
public const REFERENCE_TYPE_DIFF_UPLOAD_REQUEST = 'DIFF_UPLOAD_REQUEST';
/**
* Indicates the data is stored in diff_upload_response.
*/
public const REFERENCE_TYPE_DIFF_UPLOAD_RESPONSE = 'DIFF_UPLOAD_RESPONSE';
/**
* Indicates the data is stored in cosmo_binary_reference.
*/
public const REFERENCE_TYPE_COSMO_BINARY_REFERENCE = 'COSMO_BINARY_REFERENCE';
/**
* Informs Scotty to generate a response payload with the size specified in
* the length field. The contents of the payload are generated by Scotty and
* are undefined. This is useful for testing download speeds between the user
* and Scotty without involving a real payload source. Note: range is not
* supported when using arbitrary_bytes.
*/
public const REFERENCE_TYPE_ARBITRARY_BYTES = 'ARBITRARY_BYTES';
protected $collection_key = 'compositeMedia';
/**
* Deprecated, use one of explicit hash type fields instead. Algorithm used
* for calculating the hash. As of 2011/01/21, "MD5" is the only possible
* value for this field. New values may be added at any time.
*
* @deprecated
* @var string
*/
public $algorithm;
/**
* Use object_id instead.
*
* @deprecated
* @var string
*/
public $bigstoreObjectRef;
/**
* Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should
* be the byte representation of a blobstore.BlobRef. Since Blobstore is
* deprecating v1, use blobstore2_info instead. For now, any v2 blob will also
* be represented in this field as v1 BlobRef.
*
* @deprecated
* @var string
*/
public $blobRef;
protected $blobstore2InfoType = GdataBlobstore2Info::class;
protected $blobstore2InfoDataType = '';
protected $compositeMediaType = GdataCompositeMedia::class;
protected $compositeMediaDataType = 'array';
/**
* MIME type of the data
*
* @var string
*/
public $contentType;
protected $contentTypeInfoType = GdataContentTypeInfo::class;
protected $contentTypeInfoDataType = '';
/**
* A binary data reference for a media download. Serves as a technology-
* agnostic binary reference in some Google infrastructure. This value is a
* serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a
* hack to get around the fact that the cosmo proto (as well as others it
* includes) doesn't support JavaScript. This prevents us from including the
* actual type of this field.
*
* @var string
*/
public $cosmoBinaryReference;
/**
* For Scotty Uploads: Scotty-provided hashes for uploads For Scotty
* Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A
* Hash provided by the agent to be used to verify the data being downloaded.
* Currently only supported for inline payloads. Further, only crc32c_hash is
* currently supported.
*
* @var string
*/
public $crc32cHash;
protected $diffChecksumsResponseType = GdataDiffChecksumsResponse::class;
protected $diffChecksumsResponseDataType = '';
protected $diffDownloadResponseType = GdataDiffDownloadResponse::class;
protected $diffDownloadResponseDataType = '';
protected $diffUploadRequestType = GdataDiffUploadRequest::class;
protected $diffUploadRequestDataType = '';
protected $diffUploadResponseType = GdataDiffUploadResponse::class;
protected $diffUploadResponseDataType = '';
protected $diffVersionResponseType = GdataDiffVersionResponse::class;
protected $diffVersionResponseDataType = '';
protected $downloadParametersType = GdataDownloadParameters::class;
protected $downloadParametersDataType = '';
/**
* Original file name
*
* @var string
*/
public $filename;
/**
* Deprecated, use one of explicit hash type fields instead. These two hash
* related fields will only be populated on Scotty based media uploads and
* will contain the content of the hash group in the NotificationRequest: http
* ://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=
* class:Hash Hex encoded hash value of the uploaded media.
*
* @deprecated
* @var string
*/
public $hash;
/**
* For Scotty uploads only. If a user sends a hash code and the backend has
* requested that Scotty verify the upload against the client hash, Scotty
* will perform the check on behalf of the backend and will reject it if the
* hashes don't match. This is set to true if Scotty performed this
* verification.
*
* @var bool
*/
public $hashVerified;
/**
* Media data, set if reference_type is INLINE
*
* @var string
*/
public $inline;
/**
* |is_potential_retry| is set false only when Scotty is certain that it has
* not sent the request before. When a client resumes an upload, this field
* must be set true in agent calls, because Scotty cannot be certain that it
* has never sent the request before due to potential failure in the session
* state persistence.
*
* @var bool
*/
public $isPotentialRetry;
/**
* Size of the data, in bytes
*
* @var string
*/
public $length;
/**
* Scotty-provided MD5 hash for an upload.
*
* @var string
*/
public $md5Hash;
/**
* Media id to forward to the operation GetMedia. Can be set if reference_type
* is GET_MEDIA.
*
* @var string
*/
public $mediaId;
protected $objectIdType = GdataObjectId::class;
protected $objectIdDataType = '';
/**
* Path to the data, set if reference_type is PATH
*
* @var string
*/
public $path;
/**
* Describes what the field reference contains.
*
* @var string
*/
public $referenceType;
/**
* Scotty-provided SHA1 hash for an upload.
*
* @var string
*/
public $sha1Hash;
/**
* Scotty-provided SHA256 hash for an upload.
*
* @var string
*/
public $sha256Hash;
/**
* Time at which the media data was last updated, in milliseconds since UNIX
* epoch
*
* @var string
*/
public $timestamp;
/**
* A unique fingerprint/version id for the media data
*
* @var string
*/
public $token;
/**
* Deprecated, use one of explicit hash type fields instead. Algorithm used
* for calculating the hash. As of 2011/01/21, "MD5" is the only possible
* value for this field. New values may be added at any time.
*
* @deprecated
* @param string $algorithm
*/
public function setAlgorithm($algorithm)
{
$this->algorithm = $algorithm;
}
/**
* @deprecated
* @return string
*/
public function getAlgorithm()
{
return $this->algorithm;
}
/**
* Use object_id instead.
*
* @deprecated
* @param string $bigstoreObjectRef
*/
public function setBigstoreObjectRef($bigstoreObjectRef)
{
$this->bigstoreObjectRef = $bigstoreObjectRef;
}
/**
* @deprecated
* @return string
*/
public function getBigstoreObjectRef()
{
return $this->bigstoreObjectRef;
}
/**
* Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should
* be the byte representation of a blobstore.BlobRef. Since Blobstore is
* deprecating v1, use blobstore2_info instead. For now, any v2 blob will also
* be represented in this field as v1 BlobRef.
*
* @deprecated
* @param string $blobRef
*/
public function setBlobRef($blobRef)
{
$this->blobRef = $blobRef;
}
/**
* @deprecated
* @return string
*/
public function getBlobRef()
{
return $this->blobRef;
}
/**
* Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to
* a v2 blob.
*
* @param GdataBlobstore2Info $blobstore2Info
*/
public function setBlobstore2Info(GdataBlobstore2Info $blobstore2Info)
{
$this->blobstore2Info = $blobstore2Info;
}
/**
* @return GdataBlobstore2Info
*/
public function getBlobstore2Info()
{
return $this->blobstore2Info;
}
/**
* A composite media composed of one or more media objects, set if
* reference_type is COMPOSITE_MEDIA. The media length field must be set to
* the sum of the lengths of all composite media objects. Note: All composite
* media must have length specified.
*
* @param GdataCompositeMedia[] $compositeMedia
*/
public function setCompositeMedia($compositeMedia)
{
$this->compositeMedia = $compositeMedia;
}
/**
* @return GdataCompositeMedia[]
*/
public function getCompositeMedia()
{
return $this->compositeMedia;
}
/**
* MIME type of the data
*
* @param string $contentType
*/
public function setContentType($contentType)
{
$this->contentType = $contentType;
}
/**
* @return string
*/
public function getContentType()
{
return $this->contentType;
}
/**
* Extended content type information provided for Scotty uploads.
*
* @param GdataContentTypeInfo $contentTypeInfo
*/
public function setContentTypeInfo(GdataContentTypeInfo $contentTypeInfo)
{
$this->contentTypeInfo = $contentTypeInfo;
}
/**
* @return GdataContentTypeInfo
*/
public function getContentTypeInfo()
{
return $this->contentTypeInfo;
}
/**
* A binary data reference for a media download. Serves as a technology-
* agnostic binary reference in some Google infrastructure. This value is a
* serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a
* hack to get around the fact that the cosmo proto (as well as others it
* includes) doesn't support JavaScript. This prevents us from including the
* actual type of this field.
*
* @param string $cosmoBinaryReference
*/
public function setCosmoBinaryReference($cosmoBinaryReference)
{
$this->cosmoBinaryReference = $cosmoBinaryReference;
}
/**
* @return string
*/
public function getCosmoBinaryReference()
{
return $this->cosmoBinaryReference;
}
/**
* For Scotty Uploads: Scotty-provided hashes for uploads For Scotty
* Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A
* Hash provided by the agent to be used to verify the data being downloaded.
* Currently only supported for inline payloads. Further, only crc32c_hash is
* currently supported.
*
* @param string $crc32cHash
*/
public function setCrc32cHash($crc32cHash)
{
$this->crc32cHash = $crc32cHash;
}
/**
* @return string
*/
public function getCrc32cHash()
{
return $this->crc32cHash;
}
/**
* Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
*
* @param GdataDiffChecksumsResponse $diffChecksumsResponse
*/
public function setDiffChecksumsResponse(GdataDiffChecksumsResponse $diffChecksumsResponse)
{
$this->diffChecksumsResponse = $diffChecksumsResponse;
}
/**
* @return GdataDiffChecksumsResponse
*/
public function getDiffChecksumsResponse()
{
return $this->diffChecksumsResponse;
}
/**
* Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
*
* @param GdataDiffDownloadResponse $diffDownloadResponse
*/
public function setDiffDownloadResponse(GdataDiffDownloadResponse $diffDownloadResponse)
{
$this->diffDownloadResponse = $diffDownloadResponse;
}
/**
* @return GdataDiffDownloadResponse
*/
public function getDiffDownloadResponse()
{
return $this->diffDownloadResponse;
}
/**
* Set if reference_type is DIFF_UPLOAD_REQUEST.
*
* @param GdataDiffUploadRequest $diffUploadRequest
*/
public function setDiffUploadRequest(GdataDiffUploadRequest $diffUploadRequest)
{
$this->diffUploadRequest = $diffUploadRequest;
}
/**
* @return GdataDiffUploadRequest
*/
public function getDiffUploadRequest()
{
return $this->diffUploadRequest;
}
/**
* Set if reference_type is DIFF_UPLOAD_RESPONSE.
*
* @param GdataDiffUploadResponse $diffUploadResponse
*/
public function setDiffUploadResponse(GdataDiffUploadResponse $diffUploadResponse)
{
$this->diffUploadResponse = $diffUploadResponse;
}
/**
* @return GdataDiffUploadResponse
*/
public function getDiffUploadResponse()
{
return $this->diffUploadResponse;
}
/**
* Set if reference_type is DIFF_VERSION_RESPONSE.
*
* @param GdataDiffVersionResponse $diffVersionResponse
*/
public function setDiffVersionResponse(GdataDiffVersionResponse $diffVersionResponse)
{
$this->diffVersionResponse = $diffVersionResponse;
}
/**
* @return GdataDiffVersionResponse
*/
public function getDiffVersionResponse()
{
return $this->diffVersionResponse;
}
/**
* Parameters for a media download.
*
* @param GdataDownloadParameters $downloadParameters
*/
public function setDownloadParameters(GdataDownloadParameters $downloadParameters)
{
$this->downloadParameters = $downloadParameters;
}
/**
* @return GdataDownloadParameters
*/
public function getDownloadParameters()
{
return $this->downloadParameters;
}
/**
* Original file name
*
* @param string $filename
*/
public function setFilename($filename)
{
$this->filename = $filename;
}
/**
* @return string
*/
public function getFilename()
{
return $this->filename;
}
/**
* Deprecated, use one of explicit hash type fields instead. These two hash
* related fields will only be populated on Scotty based media uploads and
* will contain the content of the hash group in the NotificationRequest: http
* ://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=
* class:Hash Hex encoded hash value of the uploaded media.
*
* @deprecated
* @param string $hash
*/
public function setHash($hash)
{
$this->hash = $hash;
}
/**
* @deprecated
* @return string
*/
public function getHash()
{
return $this->hash;
}
/**
* For Scotty uploads only. If a user sends a hash code and the backend has
* requested that Scotty verify the upload against the client hash, Scotty
* will perform the check on behalf of the backend and will reject it if the
* hashes don't match. This is set to true if Scotty performed this
* verification.
*
* @param bool $hashVerified
*/
public function setHashVerified($hashVerified)
{
$this->hashVerified = $hashVerified;
}
/**
* @return bool
*/
public function getHashVerified()
{
return $this->hashVerified;
}
/**
* Media data, set if reference_type is INLINE
*
* @param string $inline
*/
public function setInline($inline)
{
$this->inline = $inline;
}
/**
* @return string
*/
public function getInline()
{
return $this->inline;
}
/**
* |is_potential_retry| is set false only when Scotty is certain that it has
* not sent the request before. When a client resumes an upload, this field
* must be set true in agent calls, because Scotty cannot be certain that it
* has never sent the request before due to potential failure in the session
* state persistence.
*
* @param bool $isPotentialRetry
*/
public function setIsPotentialRetry($isPotentialRetry)
{
$this->isPotentialRetry = $isPotentialRetry;
}
/**
* @return bool
*/
public function getIsPotentialRetry()
{
return $this->isPotentialRetry;
}
/**
* Size of the data, in bytes
*
* @param string $length
*/
public function setLength($length)
{
$this->length = $length;
}
/**
* @return string
*/
public function getLength()
{
return $this->length;
}
/**
* Scotty-provided MD5 hash for an upload.
*
* @param string $md5Hash
*/
public function setMd5Hash($md5Hash)
{
$this->md5Hash = $md5Hash;
}
/**
* @return string
*/
public function getMd5Hash()
{
return $this->md5Hash;
}
/**
* Media id to forward to the operation GetMedia. Can be set if reference_type
* is GET_MEDIA.
*
* @param string $mediaId
*/
public function setMediaId($mediaId)
{
$this->mediaId = $mediaId;
}
/**
* @return string
*/
public function getMediaId()
{
return $this->mediaId;
}
/**
* Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
*
* @param GdataObjectId $objectId
*/
public function setObjectId(GdataObjectId $objectId)
{
$this->objectId = $objectId;
}
/**
* @return GdataObjectId
*/
public function getObjectId()
{
return $this->objectId;
}
/**
* Path to the data, set if reference_type is PATH
*
* @param string $path
*/
public function setPath($path)
{
$this->path = $path;
}
/**
* @return string
*/
public function getPath()
{
return $this->path;
}
/**
* Describes what the field reference contains.
*
* Accepted values: PATH, BLOB_REF, INLINE, GET_MEDIA, COMPOSITE_MEDIA,
* BIGSTORE_REF, DIFF_VERSION_RESPONSE, DIFF_CHECKSUMS_RESPONSE,
* DIFF_DOWNLOAD_RESPONSE, DIFF_UPLOAD_REQUEST, DIFF_UPLOAD_RESPONSE,
* COSMO_BINARY_REFERENCE, ARBITRARY_BYTES
*
* @param self::REFERENCE_TYPE_* $referenceType
*/
public function setReferenceType($referenceType)
{
$this->referenceType = $referenceType;
}
/**
* @return self::REFERENCE_TYPE_*
*/
public function getReferenceType()
{
return $this->referenceType;
}
/**
* Scotty-provided SHA1 hash for an upload.
*
* @param string $sha1Hash
*/
public function setSha1Hash($sha1Hash)
{
$this->sha1Hash = $sha1Hash;
}
/**
* @return string
*/
public function getSha1Hash()
{
return $this->sha1Hash;
}
/**
* Scotty-provided SHA256 hash for an upload.
*
* @param string $sha256Hash
*/
public function setSha256Hash($sha256Hash)
{
$this->sha256Hash = $sha256Hash;
}
/**
* @return string
*/
public function getSha256Hash()
{
return $this->sha256Hash;
}
/**
* Time at which the media data was last updated, in milliseconds since UNIX
* epoch
*
* @param string $timestamp
*/
public function setTimestamp($timestamp)
{
$this->timestamp = $timestamp;
}
/**
* @return string
*/
public function getTimestamp()
{
return $this->timestamp;
}
/**
* A unique fingerprint/version id for the media data
*
* @param string $token
*/
public function setToken($token)
{
$this->token = $token;
}
/**
* @return string
*/
public function getToken()
{
return $this->token;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataMedia::class, 'Google_Service_DiscoveryEngine_GdataMedia');
@@ -0,0 +1,98 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GdataObjectId extends \Google\Model
{
/**
* The name of the bucket to which this object belongs.
*
* @var string
*/
public $bucketName;
/**
* Generation of the object. Generations are monotonically increasing across
* writes, allowing them to be be compared to determine which generation is
* newer. If this is omitted in a request, then you are requesting the live
* object. See http://go/bigstore-versions
*
* @var string
*/
public $generation;
/**
* The name of the object.
*
* @var string
*/
public $objectName;
/**
* The name of the bucket to which this object belongs.
*
* @param string $bucketName
*/
public function setBucketName($bucketName)
{
$this->bucketName = $bucketName;
}
/**
* @return string
*/
public function getBucketName()
{
return $this->bucketName;
}
/**
* Generation of the object. Generations are monotonically increasing across
* writes, allowing them to be be compared to determine which generation is
* newer. If this is omitted in a request, then you are requesting the live
* object. See http://go/bigstore-versions
*
* @param string $generation
*/
public function setGeneration($generation)
{
$this->generation = $generation;
}
/**
* @return string
*/
public function getGeneration()
{
return $this->generation;
}
/**
* The name of the object.
*
* @param string $objectName
*/
public function setObjectName($objectName)
{
$this->objectName = $objectName;
}
/**
* @return string
*/
public function getObjectName()
{
return $this->objectName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GdataObjectId::class, 'Google_Service_DiscoveryEngine_GdataObjectId');
@@ -0,0 +1,186 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiDistribution extends \Google\Collection
{
protected $collection_key = 'exemplars';
/**
* The number of values in each bucket of the histogram, as described in
* `bucket_options`. If the distribution does not have a histogram, then omit
* this field. If there is a histogram, then the sum of the values in
* `bucket_counts` must equal the value in the `count` field of the
* distribution. If present, `bucket_counts` should contain N values, where N
* is the number of buckets specified in `bucket_options`. If you supply fewer
* than N values, the remaining values are assumed to be 0. The order of the
* values in `bucket_counts` follows the bucket numbering schemes described
* for the three bucket types. The first value must be the count for the
* underflow bucket (number 0). The next N-2 values are the counts for the
* finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is
* the count for the overflow bucket (number N-1).
*
* @var string[]
*/
public $bucketCounts;
protected $bucketOptionsType = GoogleApiDistributionBucketOptions::class;
protected $bucketOptionsDataType = '';
/**
* The number of values in the population. Must be non-negative. This value
* must equal the sum of the values in `bucket_counts` if a histogram is
* provided.
*
* @var string
*/
public $count;
protected $exemplarsType = GoogleApiDistributionExemplar::class;
protected $exemplarsDataType = 'array';
/**
* The arithmetic mean of the values in the population. If `count` is zero
* then this field must be zero.
*
* @var
*/
public $mean;
protected $rangeType = GoogleApiDistributionRange::class;
protected $rangeDataType = '';
/**
* The sum of squared deviations from the mean of the values in the
* population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The
* Art of Computer Programming", Vol. 2, page 232, 3rd edition describes
* Welford's method for accumulating this sum in one pass. If `count` is zero
* then this field must be zero.
*
* @var
*/
public $sumOfSquaredDeviation;
/**
* The number of values in each bucket of the histogram, as described in
* `bucket_options`. If the distribution does not have a histogram, then omit
* this field. If there is a histogram, then the sum of the values in
* `bucket_counts` must equal the value in the `count` field of the
* distribution. If present, `bucket_counts` should contain N values, where N
* is the number of buckets specified in `bucket_options`. If you supply fewer
* than N values, the remaining values are assumed to be 0. The order of the
* values in `bucket_counts` follows the bucket numbering schemes described
* for the three bucket types. The first value must be the count for the
* underflow bucket (number 0). The next N-2 values are the counts for the
* finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is
* the count for the overflow bucket (number N-1).
*
* @param string[] $bucketCounts
*/
public function setBucketCounts($bucketCounts)
{
$this->bucketCounts = $bucketCounts;
}
/**
* @return string[]
*/
public function getBucketCounts()
{
return $this->bucketCounts;
}
/**
* Defines the histogram bucket boundaries. If the distribution does not
* contain a histogram, then omit this field.
*
* @param GoogleApiDistributionBucketOptions $bucketOptions
*/
public function setBucketOptions(GoogleApiDistributionBucketOptions $bucketOptions)
{
$this->bucketOptions = $bucketOptions;
}
/**
* @return GoogleApiDistributionBucketOptions
*/
public function getBucketOptions()
{
return $this->bucketOptions;
}
/**
* The number of values in the population. Must be non-negative. This value
* must equal the sum of the values in `bucket_counts` if a histogram is
* provided.
*
* @param string $count
*/
public function setCount($count)
{
$this->count = $count;
}
/**
* @return string
*/
public function getCount()
{
return $this->count;
}
/**
* Must be in increasing order of `value` field.
*
* @param GoogleApiDistributionExemplar[] $exemplars
*/
public function setExemplars($exemplars)
{
$this->exemplars = $exemplars;
}
/**
* @return GoogleApiDistributionExemplar[]
*/
public function getExemplars()
{
return $this->exemplars;
}
public function setMean($mean)
{
$this->mean = $mean;
}
public function getMean()
{
return $this->mean;
}
/**
* If specified, contains the range of the population values. The field must
* not be present if the `count` is zero.
*
* @param GoogleApiDistributionRange $range
*/
public function setRange(GoogleApiDistributionRange $range)
{
$this->range = $range;
}
/**
* @return GoogleApiDistributionRange
*/
public function getRange()
{
return $this->range;
}
public function setSumOfSquaredDeviation($sumOfSquaredDeviation)
{
$this->sumOfSquaredDeviation = $sumOfSquaredDeviation;
}
public function getSumOfSquaredDeviation()
{
return $this->sumOfSquaredDeviation;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiDistribution::class, 'Google_Service_DiscoveryEngine_GoogleApiDistribution');
@@ -0,0 +1,80 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiDistributionBucketOptions extends \Google\Model
{
protected $explicitBucketsType = GoogleApiDistributionBucketOptionsExplicit::class;
protected $explicitBucketsDataType = '';
protected $exponentialBucketsType = GoogleApiDistributionBucketOptionsExponential::class;
protected $exponentialBucketsDataType = '';
protected $linearBucketsType = GoogleApiDistributionBucketOptionsLinear::class;
protected $linearBucketsDataType = '';
/**
* The explicit buckets.
*
* @param GoogleApiDistributionBucketOptionsExplicit $explicitBuckets
*/
public function setExplicitBuckets(GoogleApiDistributionBucketOptionsExplicit $explicitBuckets)
{
$this->explicitBuckets = $explicitBuckets;
}
/**
* @return GoogleApiDistributionBucketOptionsExplicit
*/
public function getExplicitBuckets()
{
return $this->explicitBuckets;
}
/**
* The exponential buckets.
*
* @param GoogleApiDistributionBucketOptionsExponential $exponentialBuckets
*/
public function setExponentialBuckets(GoogleApiDistributionBucketOptionsExponential $exponentialBuckets)
{
$this->exponentialBuckets = $exponentialBuckets;
}
/**
* @return GoogleApiDistributionBucketOptionsExponential
*/
public function getExponentialBuckets()
{
return $this->exponentialBuckets;
}
/**
* The linear bucket.
*
* @param GoogleApiDistributionBucketOptionsLinear $linearBuckets
*/
public function setLinearBuckets(GoogleApiDistributionBucketOptionsLinear $linearBuckets)
{
$this->linearBuckets = $linearBuckets;
}
/**
* @return GoogleApiDistributionBucketOptionsLinear
*/
public function getLinearBuckets()
{
return $this->linearBuckets;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiDistributionBucketOptions::class, 'Google_Service_DiscoveryEngine_GoogleApiDistributionBucketOptions');
@@ -0,0 +1,41 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiDistributionBucketOptionsExplicit extends \Google\Collection
{
protected $collection_key = 'bounds';
/**
* The values must be monotonically increasing.
*
* @var []
*/
public $bounds;
public function setBounds($bounds)
{
$this->bounds = $bounds;
}
public function getBounds()
{
return $this->bounds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiDistributionBucketOptionsExplicit::class, 'Google_Service_DiscoveryEngine_GoogleApiDistributionBucketOptionsExplicit');
@@ -0,0 +1,76 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiDistributionBucketOptionsExponential extends \Google\Model
{
/**
* Must be greater than 1.
*
* @var
*/
public $growthFactor;
/**
* Must be greater than 0.
*
* @var int
*/
public $numFiniteBuckets;
/**
* Must be greater than 0.
*
* @var
*/
public $scale;
public function setGrowthFactor($growthFactor)
{
$this->growthFactor = $growthFactor;
}
public function getGrowthFactor()
{
return $this->growthFactor;
}
/**
* Must be greater than 0.
*
* @param int $numFiniteBuckets
*/
public function setNumFiniteBuckets($numFiniteBuckets)
{
$this->numFiniteBuckets = $numFiniteBuckets;
}
/**
* @return int
*/
public function getNumFiniteBuckets()
{
return $this->numFiniteBuckets;
}
public function setScale($scale)
{
$this->scale = $scale;
}
public function getScale()
{
return $this->scale;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiDistributionBucketOptionsExponential::class, 'Google_Service_DiscoveryEngine_GoogleApiDistributionBucketOptionsExponential');
@@ -0,0 +1,76 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiDistributionBucketOptionsLinear extends \Google\Model
{
/**
* Must be greater than 0.
*
* @var int
*/
public $numFiniteBuckets;
/**
* Lower bound of the first bucket.
*
* @var
*/
public $offset;
/**
* Must be greater than 0.
*
* @var
*/
public $width;
/**
* Must be greater than 0.
*
* @param int $numFiniteBuckets
*/
public function setNumFiniteBuckets($numFiniteBuckets)
{
$this->numFiniteBuckets = $numFiniteBuckets;
}
/**
* @return int
*/
public function getNumFiniteBuckets()
{
return $this->numFiniteBuckets;
}
public function setOffset($offset)
{
$this->offset = $offset;
}
public function getOffset()
{
return $this->offset;
}
public function setWidth($width)
{
$this->width = $width;
}
public function getWidth()
{
return $this->width;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiDistributionBucketOptionsLinear::class, 'Google_Service_DiscoveryEngine_GoogleApiDistributionBucketOptionsLinear');
@@ -0,0 +1,96 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiDistributionExemplar extends \Google\Collection
{
protected $collection_key = 'attachments';
/**
* Contextual information about the example value. Examples are: Trace:
* type.googleapis.com/google.monitoring.v3.SpanContext Literal string:
* type.googleapis.com/google.protobuf.StringValue Labels dropped during
* aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There
* may be only a single attachment of any given message type in a single
* exemplar, and this is enforced by the system.
*
* @var array[]
*/
public $attachments;
/**
* The observation (sampling) time of the above value.
*
* @var string
*/
public $timestamp;
/**
* Value of the exemplar point. This value determines to which bucket the
* exemplar belongs.
*
* @var
*/
public $value;
/**
* Contextual information about the example value. Examples are: Trace:
* type.googleapis.com/google.monitoring.v3.SpanContext Literal string:
* type.googleapis.com/google.protobuf.StringValue Labels dropped during
* aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There
* may be only a single attachment of any given message type in a single
* exemplar, and this is enforced by the system.
*
* @param array[] $attachments
*/
public function setAttachments($attachments)
{
$this->attachments = $attachments;
}
/**
* @return array[]
*/
public function getAttachments()
{
return $this->attachments;
}
/**
* The observation (sampling) time of the above value.
*
* @param string $timestamp
*/
public function setTimestamp($timestamp)
{
$this->timestamp = $timestamp;
}
/**
* @return string
*/
public function getTimestamp()
{
return $this->timestamp;
}
public function setValue($value)
{
$this->value = $value;
}
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiDistributionExemplar::class, 'Google_Service_DiscoveryEngine_GoogleApiDistributionExemplar');
@@ -0,0 +1,54 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiDistributionRange extends \Google\Model
{
/**
* The maximum of the population values.
*
* @var
*/
public $max;
/**
* The minimum of the population values.
*
* @var
*/
public $min;
public function setMax($max)
{
$this->max = $max;
}
public function getMax()
{
return $this->max;
}
public function setMin($min)
{
$this->min = $min;
}
public function getMin()
{
return $this->min;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiDistributionRange::class, 'Google_Service_DiscoveryEngine_GoogleApiDistributionRange');
@@ -0,0 +1,95 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiHttpBody extends \Google\Collection
{
protected $collection_key = 'extensions';
/**
* The HTTP Content-Type header value specifying the content type of the body.
*
* @var string
*/
public $contentType;
/**
* The HTTP request/response body as raw binary.
*
* @var string
*/
public $data;
/**
* Application specific response metadata. Must be set in the first response
* for streaming APIs.
*
* @var array[]
*/
public $extensions;
/**
* The HTTP Content-Type header value specifying the content type of the body.
*
* @param string $contentType
*/
public function setContentType($contentType)
{
$this->contentType = $contentType;
}
/**
* @return string
*/
public function getContentType()
{
return $this->contentType;
}
/**
* The HTTP request/response body as raw binary.
*
* @param string $data
*/
public function setData($data)
{
$this->data = $data;
}
/**
* @return string
*/
public function getData()
{
return $this->data;
}
/**
* Application specific response metadata. Must be set in the first response
* for streaming APIs.
*
* @param array[] $extensions
*/
public function setExtensions($extensions)
{
$this->extensions = $extensions;
}
/**
* @return array[]
*/
public function getExtensions()
{
return $this->extensions;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiHttpBody::class, 'Google_Service_DiscoveryEngine_GoogleApiHttpBody');
@@ -0,0 +1,74 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiMetric extends \Google\Model
{
/**
* The set of label values that uniquely identify this metric. All labels
* listed in the `MetricDescriptor` must be assigned values.
*
* @var string[]
*/
public $labels;
/**
* An existing metric type, see google.api.MetricDescriptor. For example,
* `custom.googleapis.com/invoice/paid/amount`.
*
* @var string
*/
public $type;
/**
* The set of label values that uniquely identify this metric. All labels
* listed in the `MetricDescriptor` must be assigned values.
*
* @param string[] $labels
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
/**
* An existing metric type, see google.api.MetricDescriptor. For example,
* `custom.googleapis.com/invoice/paid/amount`.
*
* @param string $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiMetric::class, 'Google_Service_DiscoveryEngine_GoogleApiMetric');
@@ -0,0 +1,82 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiMonitoredResource extends \Google\Model
{
/**
* Required. Values for all of the labels listed in the associated monitored
* resource descriptor. For example, Compute Engine VM instances use the
* labels `"project_id"`, `"instance_id"`, and `"zone"`.
*
* @var string[]
*/
public $labels;
/**
* Required. The monitored resource type. This field must match the `type`
* field of a MonitoredResourceDescriptor object. For example, the type of a
* Compute Engine VM instance is `gce_instance`. Some descriptors include the
* service name in the type; for example, the type of a Datastream stream is
* `datastream.googleapis.com/Stream`.
*
* @var string
*/
public $type;
/**
* Required. Values for all of the labels listed in the associated monitored
* resource descriptor. For example, Compute Engine VM instances use the
* labels `"project_id"`, `"instance_id"`, and `"zone"`.
*
* @param string[] $labels
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
/**
* Required. The monitored resource type. This field must match the `type`
* field of a MonitoredResourceDescriptor object. For example, the type of a
* Compute Engine VM instance is `gce_instance`. Some descriptors include the
* service name in the type; for example, the type of a Datastream stream is
* `datastream.googleapis.com/Stream`.
*
* @param string $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiMonitoredResource::class, 'Google_Service_DiscoveryEngine_GoogleApiMonitoredResource');
@@ -0,0 +1,80 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleApiMonitoredResourceMetadata extends \Google\Model
{
/**
* Output only. Values for predefined system metadata labels. System labels
* are a kind of metadata extracted by Google, including "machine_image",
* "vpc", "subnet_id", "security_group", "name", etc. System label values can
* be only strings, Boolean values, or a list of strings. For example: {
* "name": "my-test-instance", "security_group": ["a", "b", "c"],
* "spot_instance": false }
*
* @var array[]
*/
public $systemLabels;
/**
* Output only. A map of user-defined metadata labels.
*
* @var string[]
*/
public $userLabels;
/**
* Output only. Values for predefined system metadata labels. System labels
* are a kind of metadata extracted by Google, including "machine_image",
* "vpc", "subnet_id", "security_group", "name", etc. System label values can
* be only strings, Boolean values, or a list of strings. For example: {
* "name": "my-test-instance", "security_group": ["a", "b", "c"],
* "spot_instance": false }
*
* @param array[] $systemLabels
*/
public function setSystemLabels($systemLabels)
{
$this->systemLabels = $systemLabels;
}
/**
* @return array[]
*/
public function getSystemLabels()
{
return $this->systemLabels;
}
/**
* Output only. A map of user-defined metadata labels.
*
* @param string[] $userLabels
*/
public function setUserLabels($userLabels)
{
$this->userLabels = $userLabels;
}
/**
* @return string[]
*/
public function getUserLabels()
{
return $this->userLabels;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleApiMonitoredResourceMetadata::class, 'Google_Service_DiscoveryEngine_GoogleApiMonitoredResourceMetadata');
@@ -0,0 +1,186 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext extends \Google\Model
{
/**
* The full resource name of the Connector Run. Format:
* `projects/locations/collections/dataConnector/connectorRuns`. The
* `connector_run_id` is system-generated.
*
* @var string
*/
public $connectorRun;
/**
* The full resource name of the DataConnector. Format:
* `projects/locations/collections/dataConnector`.
*
* @var string
*/
public $dataConnector;
/**
* The time when the connector run ended.
*
* @var string
*/
public $endTime;
/**
* The entity to sync for the connector run.
*
* @var string
*/
public $entity;
/**
* The operation resource name of the LRO to sync the connector.
*
* @var string
*/
public $operation;
/**
* The time when the connector run started.
*
* @var string
*/
public $startTime;
/**
* The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`
*
* @var string
*/
public $syncType;
/**
* The full resource name of the Connector Run. Format:
* `projects/locations/collections/dataConnector/connectorRuns`. The
* `connector_run_id` is system-generated.
*
* @param string $connectorRun
*/
public function setConnectorRun($connectorRun)
{
$this->connectorRun = $connectorRun;
}
/**
* @return string
*/
public function getConnectorRun()
{
return $this->connectorRun;
}
/**
* The full resource name of the DataConnector. Format:
* `projects/locations/collections/dataConnector`.
*
* @param string $dataConnector
*/
public function setDataConnector($dataConnector)
{
$this->dataConnector = $dataConnector;
}
/**
* @return string
*/
public function getDataConnector()
{
return $this->dataConnector;
}
/**
* The time when the connector run ended.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* The entity to sync for the connector run.
*
* @param string $entity
*/
public function setEntity($entity)
{
$this->entity = $entity;
}
/**
* @return string
*/
public function getEntity()
{
return $this->entity;
}
/**
* The operation resource name of the LRO to sync the connector.
*
* @param string $operation
*/
public function setOperation($operation)
{
$this->operation = $operation;
}
/**
* @return string
*/
public function getOperation()
{
return $this->operation;
}
/**
* The time when the connector run started.
*
* @param string $startTime
*/
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
/**
* @return string
*/
public function getStartTime()
{
return $this->startTime;
}
/**
* The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`
*
* @param string $syncType
*/
public function setSyncType($syncType)
{
$this->syncType = $syncType;
}
/**
* @return string
*/
public function getSyncType()
{
return $this->syncType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext');
@@ -0,0 +1,63 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineLoggingErrorContext extends \Google\Model
{
protected $httpRequestType = GoogleCloudDiscoveryengineLoggingHttpRequestContext::class;
protected $httpRequestDataType = '';
protected $reportLocationType = GoogleCloudDiscoveryengineLoggingSourceLocation::class;
protected $reportLocationDataType = '';
/**
* The HTTP request which was processed when the error was triggered.
*
* @param GoogleCloudDiscoveryengineLoggingHttpRequestContext $httpRequest
*/
public function setHttpRequest(GoogleCloudDiscoveryengineLoggingHttpRequestContext $httpRequest)
{
$this->httpRequest = $httpRequest;
}
/**
* @return GoogleCloudDiscoveryengineLoggingHttpRequestContext
*/
public function getHttpRequest()
{
return $this->httpRequest;
}
/**
* The location in the source code where the decision was made to report the
* error, usually the place where it was logged.
*
* @param GoogleCloudDiscoveryengineLoggingSourceLocation $reportLocation
*/
public function setReportLocation(GoogleCloudDiscoveryengineLoggingSourceLocation $reportLocation)
{
$this->reportLocation = $reportLocation;
}
/**
* @return GoogleCloudDiscoveryengineLoggingSourceLocation
*/
public function getReportLocation()
{
return $this->reportLocation;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineLoggingErrorContext::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorContext');
@@ -0,0 +1,202 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineLoggingErrorLog extends \Google\Model
{
protected $connectorRunPayloadType = GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext::class;
protected $connectorRunPayloadDataType = '';
protected $contextType = GoogleCloudDiscoveryengineLoggingErrorContext::class;
protected $contextDataType = '';
protected $importPayloadType = GoogleCloudDiscoveryengineLoggingImportErrorContext::class;
protected $importPayloadDataType = '';
/**
* A message describing the error.
*
* @var string
*/
public $message;
/**
* The API request payload, represented as a protocol buffer. Most API request
* types are supported—for example: * `type.googleapis.com/google.cloud.discov
* eryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis
* .com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRe
* quest`
*
* @var array[]
*/
public $requestPayload;
/**
* 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.CollectUserEvent`
*
* @var array[]
*/
public $responsePayload;
protected $serviceContextType = GoogleCloudDiscoveryengineLoggingServiceContext::class;
protected $serviceContextDataType = '';
protected $statusType = GoogleRpcStatus::class;
protected $statusDataType = '';
/**
* The error payload that is populated on LRO connector sync APIs.
*
* @param GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext $connectorRunPayload
*/
public function setConnectorRunPayload(GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext $connectorRunPayload)
{
$this->connectorRunPayload = $connectorRunPayload;
}
/**
* @return GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext
*/
public function getConnectorRunPayload()
{
return $this->connectorRunPayload;
}
/**
* A description of the context in which the error occurred.
*
* @param GoogleCloudDiscoveryengineLoggingErrorContext $context
*/
public function setContext(GoogleCloudDiscoveryengineLoggingErrorContext $context)
{
$this->context = $context;
}
/**
* @return GoogleCloudDiscoveryengineLoggingErrorContext
*/
public function getContext()
{
return $this->context;
}
/**
* The error payload that is populated on LRO import APIs.
*
* @param GoogleCloudDiscoveryengineLoggingImportErrorContext $importPayload
*/
public function setImportPayload(GoogleCloudDiscoveryengineLoggingImportErrorContext $importPayload)
{
$this->importPayload = $importPayload;
}
/**
* @return GoogleCloudDiscoveryengineLoggingImportErrorContext
*/
public function getImportPayload()
{
return $this->importPayload;
}
/**
* A message describing the error.
*
* @param string $message
*/
public function setMessage($message)
{
$this->message = $message;
}
/**
* @return string
*/
public function getMessage()
{
return $this->message;
}
/**
* The API request payload, represented as a protocol buffer. Most API request
* types are supported—for example: * `type.googleapis.com/google.cloud.discov
* eryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis
* .com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRe
* quest`
*
* @param array[] $requestPayload
*/
public function setRequestPayload($requestPayload)
{
$this->requestPayload = $requestPayload;
}
/**
* @return array[]
*/
public function getRequestPayload()
{
return $this->requestPayload;
}
/**
* 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.CollectUserEvent`
*
* @param array[] $responsePayload
*/
public function setResponsePayload($responsePayload)
{
$this->responsePayload = $responsePayload;
}
/**
* @return array[]
*/
public function getResponsePayload()
{
return $this->responsePayload;
}
/**
* The service context in which this error has occurred.
*
* @param GoogleCloudDiscoveryengineLoggingServiceContext $serviceContext
*/
public function setServiceContext(GoogleCloudDiscoveryengineLoggingServiceContext $serviceContext)
{
$this->serviceContext = $serviceContext;
}
/**
* @return GoogleCloudDiscoveryengineLoggingServiceContext
*/
public function getServiceContext()
{
return $this->serviceContext;
}
/**
* The RPC status associated with the error log.
*
* @param GoogleRpcStatus $status
*/
public function setStatus(GoogleRpcStatus $status)
{
$this->status = $status;
}
/**
* @return GoogleRpcStatus
*/
public function getStatus()
{
return $this->status;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineLoggingErrorLog::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineLoggingHttpRequestContext extends \Google\Model
{
/**
* The HTTP response status code for the request.
*
* @var int
*/
public $responseStatusCode;
/**
* The HTTP response status code for the request.
*
* @param int $responseStatusCode
*/
public function setResponseStatusCode($responseStatusCode)
{
$this->responseStatusCode = $responseStatusCode;
}
/**
* @return int
*/
public function getResponseStatusCode()
{
return $this->responseStatusCode;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineLoggingHttpRequestContext::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineLoggingHttpRequestContext');
@@ -0,0 +1,140 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineLoggingImportErrorContext extends \Google\Model
{
/**
* The detailed content which caused the error on importing a document.
*
* @var string
*/
public $document;
/**
* Google Cloud Storage file path of the import source. Can be set for batch
* operation error.
*
* @var string
*/
public $gcsPath;
/**
* Line number of the content in file. Should be empty for permission or batch
* operation error.
*
* @var string
*/
public $lineNumber;
/**
* The operation resource name of the LRO.
*
* @var string
*/
public $operation;
/**
* The detailed content which caused the error on importing a user event.
*
* @var string
*/
public $userEvent;
/**
* The detailed content which caused the error on importing a document.
*
* @param string $document
*/
public function setDocument($document)
{
$this->document = $document;
}
/**
* @return string
*/
public function getDocument()
{
return $this->document;
}
/**
* Google Cloud Storage file path of the import source. Can be set for batch
* operation error.
*
* @param string $gcsPath
*/
public function setGcsPath($gcsPath)
{
$this->gcsPath = $gcsPath;
}
/**
* @return string
*/
public function getGcsPath()
{
return $this->gcsPath;
}
/**
* Line number of the content in file. Should be empty for permission or batch
* operation error.
*
* @param string $lineNumber
*/
public function setLineNumber($lineNumber)
{
$this->lineNumber = $lineNumber;
}
/**
* @return string
*/
public function getLineNumber()
{
return $this->lineNumber;
}
/**
* The operation resource name of the LRO.
*
* @param string $operation
*/
public function setOperation($operation)
{
$this->operation = $operation;
}
/**
* @return string
*/
public function getOperation()
{
return $this->operation;
}
/**
* The detailed content which caused the error on importing a user event.
*
* @param string $userEvent
*/
public function setUserEvent($userEvent)
{
$this->userEvent = $userEvent;
}
/**
* @return string
*/
public function getUserEvent()
{
return $this->userEvent;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineLoggingImportErrorContext::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineLoggingImportErrorContext');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineLoggingServiceContext extends \Google\Model
{
/**
* An identifier of the service—for example, `discoveryengine.googleapis.com`.
*
* @var string
*/
public $service;
/**
* An identifier of the service—for example, `discoveryengine.googleapis.com`.
*
* @param string $service
*/
public function setService($service)
{
$this->service = $service;
}
/**
* @return string
*/
public function getService()
{
return $this->service;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineLoggingServiceContext::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineLoggingServiceContext');
@@ -0,0 +1,50 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineLoggingSourceLocation extends \Google\Model
{
/**
* Human-readable name of a function or method—for example,
* `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.
*
* @var string
*/
public $functionName;
/**
* Human-readable name of a function or method—for example,
* `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.
*
* @param string $functionName
*/
public function setFunctionName($functionName)
{
$this->functionName = $functionName;
}
/**
* @return string
*/
public function getFunctionName()
{
return $this->functionName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineLoggingSourceLocation::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineLoggingSourceLocation');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AclConfig extends \Google\Model
{
protected $idpConfigType = GoogleCloudDiscoveryengineV1IdpConfig::class;
protected $idpConfigDataType = '';
/**
* Immutable. The full resource name of the acl configuration. Format:
* `projects/{project}/locations/{location}/aclConfig`. This field must be a
* UTF-8 encoded string with a length limit of 1024 characters.
*
* @var string
*/
public $name;
/**
* Identity provider config.
*
* @param GoogleCloudDiscoveryengineV1IdpConfig $idpConfig
*/
public function setIdpConfig(GoogleCloudDiscoveryengineV1IdpConfig $idpConfig)
{
$this->idpConfig = $idpConfig;
}
/**
* @return GoogleCloudDiscoveryengineV1IdpConfig
*/
public function getIdpConfig()
{
return $this->idpConfig;
}
/**
* Immutable. The full resource name of the acl configuration. Format:
* `projects/{project}/locations/{location}/aclConfig`. This field must be a
* UTF-8 encoded string with a length limit of 1024 characters.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AclConfig::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AclConfig');
@@ -0,0 +1,187 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1ActionConfig extends \Google\Model
{
/**
* Optional. Action parameters in structured json format.
*
* @var array[]
*/
public $actionParams;
/**
* Optional. Whether to create a BAP connection for the connector.
*
* @var bool
*/
public $createBapConnection;
/**
* Output only. The connector contains the necessary parameters and is
* configured to support actions.
*
* @var bool
*/
public $isActionConfigured;
/**
* Optional. Action parameters in json string format.
*
* @var string
*/
public $jsonActionParams;
/**
* Optional. The Service Directory resource name
* (projects/locations/namespaces/services) representing a VPC network
* endpoint used to connect to the data source's `instance_uri`, defined in
* DataConnector.params. Required when VPC Service Controls are enabled.
*
* @var string
*/
public $serviceName;
/**
* Optional. Whether to use static secrets for the connector. If true, the
* secrets provided in the action_params will be ignored.
*
* @var bool
*/
public $useStaticSecrets;
protected $userDefinedScopesMappingType = GoogleCloudDiscoveryengineV1ActionConfigScopeList::class;
protected $userDefinedScopesMappingDataType = 'map';
/**
* Optional. Action parameters in structured json format.
*
* @param array[] $actionParams
*/
public function setActionParams($actionParams)
{
$this->actionParams = $actionParams;
}
/**
* @return array[]
*/
public function getActionParams()
{
return $this->actionParams;
}
/**
* Optional. Whether to create a BAP connection for the connector.
*
* @param bool $createBapConnection
*/
public function setCreateBapConnection($createBapConnection)
{
$this->createBapConnection = $createBapConnection;
}
/**
* @return bool
*/
public function getCreateBapConnection()
{
return $this->createBapConnection;
}
/**
* Output only. The connector contains the necessary parameters and is
* configured to support actions.
*
* @param bool $isActionConfigured
*/
public function setIsActionConfigured($isActionConfigured)
{
$this->isActionConfigured = $isActionConfigured;
}
/**
* @return bool
*/
public function getIsActionConfigured()
{
return $this->isActionConfigured;
}
/**
* Optional. Action parameters in json string format.
*
* @param string $jsonActionParams
*/
public function setJsonActionParams($jsonActionParams)
{
$this->jsonActionParams = $jsonActionParams;
}
/**
* @return string
*/
public function getJsonActionParams()
{
return $this->jsonActionParams;
}
/**
* Optional. The Service Directory resource name
* (projects/locations/namespaces/services) representing a VPC network
* endpoint used to connect to the data source's `instance_uri`, defined in
* DataConnector.params. Required when VPC Service Controls are enabled.
*
* @param string $serviceName
*/
public function setServiceName($serviceName)
{
$this->serviceName = $serviceName;
}
/**
* @return string
*/
public function getServiceName()
{
return $this->serviceName;
}
/**
* Optional. Whether to use static secrets for the connector. If true, the
* secrets provided in the action_params will be ignored.
*
* @param bool $useStaticSecrets
*/
public function setUseStaticSecrets($useStaticSecrets)
{
$this->useStaticSecrets = $useStaticSecrets;
}
/**
* @return bool
*/
public function getUseStaticSecrets()
{
return $this->useStaticSecrets;
}
/**
* Optional. Mapping from operation name to the list of scopes. Only be
* populated if there are user specified scopes.
*
* @param GoogleCloudDiscoveryengineV1ActionConfigScopeList[] $userDefinedScopesMapping
*/
public function setUserDefinedScopesMapping($userDefinedScopesMapping)
{
$this->userDefinedScopesMapping = $userDefinedScopesMapping;
}
/**
* @return GoogleCloudDiscoveryengineV1ActionConfigScopeList[]
*/
public function getUserDefinedScopesMapping()
{
return $this->userDefinedScopesMapping;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1ActionConfig::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig');
@@ -0,0 +1,49 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1ActionConfigScopeList extends \Google\Collection
{
protected $collection_key = 'scopes';
/**
* Optional. The list of scopes.
*
* @var string[]
*/
public $scopes;
/**
* Optional. The list of scopes.
*
* @param string[] $scopes
*/
public function setScopes($scopes)
{
$this->scopes = $scopes;
}
/**
* @return string[]
*/
public function getScopes()
{
return $this->scopes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1ActionConfigScopeList::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfigScopeList');
@@ -0,0 +1,268 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest extends \Google\Collection
{
protected $collection_key = 'suggestionTypes';
protected $boostSpecType = GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec::class;
protected $boostSpecDataType = '';
/**
* Optional. Experiment ids for this request.
*
* @var string[]
*/
public $experimentIds;
/**
* Indicates if tail suggestions should be returned if there are no
* suggestions that match the full query. Even if set to true, if there are
* suggestions that match the full query, those are returned and no tail
* suggestions are returned.
*
* @var bool
*/
public $includeTailSuggestions;
/**
* Required. The typeahead input used to fetch suggestions. Maximum length is
* 128 characters. The query can not be empty for most of the suggestion
* types. If it is empty, an `INVALID_ARGUMENT` error is returned. The
* exception is when the suggestion_types contains only the type
* `RECENT_SEARCH`, the query can be an empty string. The is called "zero
* prefix" feature, which returns user's recently searched queries given the
* empty query.
*
* @var string
*/
public $query;
/**
* Specifies the autocomplete query model, which only applies to the QUERY
* SuggestionType. This overrides any model specified in the Configuration >
* Autocomplete section of the Cloud console. Currently supported values: *
* `document` - Using suggestions generated from user-imported documents. *
* `search-history` - Using suggestions generated from the past history of
* SearchService.Search API calls. Do not use it when there is no traffic for
* Search API. * `user-event` - Using suggestions generated from user-imported
* search events. * `document-completable` - Using suggestions taken directly
* from user-imported document fields marked as completable. Default values: *
* `document` is the default model for regular dataStores. * `search-history`
* is the default model for site search dataStores.
*
* @var string
*/
public $queryModel;
protected $suggestionTypeSpecsType = GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec::class;
protected $suggestionTypeSpecsDataType = 'array';
/**
* Optional. Suggestion types to return. If empty or unspecified, query
* suggestions are returned. Only one suggestion type is supported at the
* moment.
*
* @var string[]
*/
public $suggestionTypes;
protected $userInfoType = GoogleCloudDiscoveryengineV1UserInfo::class;
protected $userInfoDataType = '';
/**
* Optional. 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 logs in or out of the website. This field should NOT
* have a fixed value such as `unknown_visitor`. This should be the same
* identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id.
* The field must be a UTF-8 encoded string with a length limit of 128
*
* @var string
*/
public $userPseudoId;
/**
* Optional. Specification to boost suggestions matching the condition.
*
* @param GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec $boostSpec
*/
public function setBoostSpec(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec $boostSpec)
{
$this->boostSpec = $boostSpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec
*/
public function getBoostSpec()
{
return $this->boostSpec;
}
/**
* Optional. Experiment ids for this request.
*
* @param string[] $experimentIds
*/
public function setExperimentIds($experimentIds)
{
$this->experimentIds = $experimentIds;
}
/**
* @return string[]
*/
public function getExperimentIds()
{
return $this->experimentIds;
}
/**
* Indicates if tail suggestions should be returned if there are no
* suggestions that match the full query. Even if set to true, if there are
* suggestions that match the full query, those are returned and no tail
* suggestions are returned.
*
* @param bool $includeTailSuggestions
*/
public function setIncludeTailSuggestions($includeTailSuggestions)
{
$this->includeTailSuggestions = $includeTailSuggestions;
}
/**
* @return bool
*/
public function getIncludeTailSuggestions()
{
return $this->includeTailSuggestions;
}
/**
* Required. The typeahead input used to fetch suggestions. Maximum length is
* 128 characters. The query can not be empty for most of the suggestion
* types. If it is empty, an `INVALID_ARGUMENT` error is returned. The
* exception is when the suggestion_types contains only the type
* `RECENT_SEARCH`, the query can be an empty string. The is called "zero
* prefix" feature, which returns user's recently searched queries given the
* empty query.
*
* @param string $query
*/
public function setQuery($query)
{
$this->query = $query;
}
/**
* @return string
*/
public function getQuery()
{
return $this->query;
}
/**
* Specifies the autocomplete query model, which only applies to the QUERY
* SuggestionType. This overrides any model specified in the Configuration >
* Autocomplete section of the Cloud console. Currently supported values: *
* `document` - Using suggestions generated from user-imported documents. *
* `search-history` - Using suggestions generated from the past history of
* SearchService.Search API calls. Do not use it when there is no traffic for
* Search API. * `user-event` - Using suggestions generated from user-imported
* search events. * `document-completable` - Using suggestions taken directly
* from user-imported document fields marked as completable. Default values: *
* `document` is the default model for regular dataStores. * `search-history`
* is the default model for site search dataStores.
*
* @param string $queryModel
*/
public function setQueryModel($queryModel)
{
$this->queryModel = $queryModel;
}
/**
* @return string
*/
public function getQueryModel()
{
return $this->queryModel;
}
/**
* Optional. Specification of each suggestion type.
*
* @param GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec[] $suggestionTypeSpecs
*/
public function setSuggestionTypeSpecs($suggestionTypeSpecs)
{
$this->suggestionTypeSpecs = $suggestionTypeSpecs;
}
/**
* @return GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec[]
*/
public function getSuggestionTypeSpecs()
{
return $this->suggestionTypeSpecs;
}
/**
* Optional. Suggestion types to return. If empty or unspecified, query
* suggestions are returned. Only one suggestion type is supported at the
* moment.
*
* @param string[] $suggestionTypes
*/
public function setSuggestionTypes($suggestionTypes)
{
$this->suggestionTypes = $suggestionTypes;
}
/**
* @return string[]
*/
public function getSuggestionTypes()
{
return $this->suggestionTypes;
}
/**
* Optional. Information about the end user. This should be the same
* identifier information as UserEvent.user_info and SearchRequest.user_info.
*
* @param GoogleCloudDiscoveryengineV1UserInfo $userInfo
*/
public function setUserInfo(GoogleCloudDiscoveryengineV1UserInfo $userInfo)
{
$this->userInfo = $userInfo;
}
/**
* @return GoogleCloudDiscoveryengineV1UserInfo
*/
public function getUserInfo()
{
return $this->userInfo;
}
/**
* Optional. 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 logs in or out of the website. This field should NOT
* have a fixed value such as `unknown_visitor`. This should be the same
* identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id.
* The field must be a UTF-8 encoded string with a length limit of 128
*
* @param string $userPseudoId
*/
public function setUserPseudoId($userPseudoId)
{
$this->userPseudoId = $userPseudoId;
}
/**
* @return string
*/
public function getUserPseudoId()
{
return $this->userPseudoId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec extends \Google\Collection
{
protected $collection_key = 'conditionBoostSpecs';
protected $conditionBoostSpecsType = GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec::class;
protected $conditionBoostSpecsDataType = 'array';
/**
* Condition boost specifications. If a suggestion matches multiple conditions
* in the specifications, boost values from these specifications are all
* applied and combined in a non-linear way. Maximum number of specifications
* is 20. Note: Currently only support language condition boost.
*
* @param GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec[] $conditionBoostSpecs
*/
public function setConditionBoostSpecs($conditionBoostSpecs)
{
$this->conditionBoostSpecs = $conditionBoostSpecs;
}
/**
* @return GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec[]
*/
public function getConditionBoostSpecs()
{
return $this->conditionBoostSpecs;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec');
@@ -0,0 +1,90 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec extends \Google\Model
{
/**
* Strength of the boost, which should be in [-1, 1]. Negative boost means
* demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big
* promotion. However, it does not necessarily mean that the top result will
* be a boosted suggestion. Setting to -1.0 gives the suggestions a big
* demotion. However, other suggestions that are relevant might still be
* shown. Setting to 0.0 means no boost applied. The boosting condition is
* ignored.
*
* @var float
*/
public $boost;
/**
* An expression which specifies a boost condition. The syntax is the same as
* [filter expression syntax](https://cloud.google.com/generative-ai-app-
* builder/docs/filter-search-metadata#filter-expression-syntax). Currently,
* the only supported condition is a list of BCP-47 lang codes. Example: * To
* boost suggestions in languages `en` or `fr`: `(lang_code: ANY("en", "fr"))`
*
* @var string
*/
public $condition;
/**
* Strength of the boost, which should be in [-1, 1]. Negative boost means
* demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big
* promotion. However, it does not necessarily mean that the top result will
* be a boosted suggestion. Setting to -1.0 gives the suggestions a big
* demotion. However, other suggestions that are relevant might still be
* shown. Setting to 0.0 means no boost applied. The boosting condition is
* ignored.
*
* @param float $boost
*/
public function setBoost($boost)
{
$this->boost = $boost;
}
/**
* @return float
*/
public function getBoost()
{
return $this->boost;
}
/**
* An expression which specifies a boost condition. The syntax is the same as
* [filter expression syntax](https://cloud.google.com/generative-ai-app-
* builder/docs/filter-search-metadata#filter-expression-syntax). Currently,
* the only supported condition is a list of BCP-47 lang codes. Example: * To
* boost suggestions in languages `en` or `fr`: `(lang_code: ANY("en", "fr"))`
*
* @param string $condition
*/
public function setCondition($condition)
{
$this->condition = $condition;
}
/**
* @return string
*/
public function getCondition()
{
return $this->condition;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec');
@@ -0,0 +1,97 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec extends \Google\Model
{
/**
* Default value.
*/
public const SUGGESTION_TYPE_SUGGESTION_TYPE_UNSPECIFIED = 'SUGGESTION_TYPE_UNSPECIFIED';
/**
* Returns query suggestions.
*/
public const SUGGESTION_TYPE_QUERY = 'QUERY';
/**
* Returns people suggestions.
*/
public const SUGGESTION_TYPE_PEOPLE = 'PEOPLE';
/**
* Returns content suggestions.
*/
public const SUGGESTION_TYPE_CONTENT = 'CONTENT';
/**
* Returns recent search suggestions.
*/
public const SUGGESTION_TYPE_RECENT_SEARCH = 'RECENT_SEARCH';
/**
* Returns Google Workspace suggestions.
*/
public const SUGGESTION_TYPE_GOOGLE_WORKSPACE = 'GOOGLE_WORKSPACE';
/**
* Optional. Maximum number of suggestions to return for each suggestion type.
*
* @var int
*/
public $maxSuggestions;
/**
* Optional. Suggestion type.
*
* @var string
*/
public $suggestionType;
/**
* Optional. Maximum number of suggestions to return for each suggestion type.
*
* @param int $maxSuggestions
*/
public function setMaxSuggestions($maxSuggestions)
{
$this->maxSuggestions = $maxSuggestions;
}
/**
* @return int
*/
public function getMaxSuggestions()
{
return $this->maxSuggestions;
}
/**
* Optional. Suggestion type.
*
* Accepted values: SUGGESTION_TYPE_UNSPECIFIED, QUERY, PEOPLE, CONTENT,
* RECENT_SEARCH, GOOGLE_WORKSPACE
*
* @param self::SUGGESTION_TYPE_* $suggestionType
*/
public function setSuggestionType($suggestionType)
{
$this->suggestionType = $suggestionType;
}
/**
* @return self::SUGGESTION_TYPE_*
*/
public function getSuggestionType()
{
return $this->suggestionType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec');
@@ -0,0 +1,129 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse extends \Google\Collection
{
protected $collection_key = 'recentSearchSuggestions';
protected $contentSuggestionsType = GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion::class;
protected $contentSuggestionsDataType = 'array';
protected $peopleSuggestionsType = GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion::class;
protected $peopleSuggestionsDataType = 'array';
protected $querySuggestionsType = GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion::class;
protected $querySuggestionsDataType = 'array';
protected $recentSearchSuggestionsType = GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion::class;
protected $recentSearchSuggestionsDataType = 'array';
/**
* True if the returned suggestions are all tail suggestions. For tail
* matching to be triggered, include_tail_suggestions in the request must be
* true and there must be no suggestions that match the full query.
*
* @var bool
*/
public $tailMatchTriggered;
/**
* Results of the matched content suggestions. The result list is ordered and
* the first result is the top suggestion.
*
* @param GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion[] $contentSuggestions
*/
public function setContentSuggestions($contentSuggestions)
{
$this->contentSuggestions = $contentSuggestions;
}
/**
* @return GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion[]
*/
public function getContentSuggestions()
{
return $this->contentSuggestions;
}
/**
* Results of the matched people suggestions. The result list is ordered and
* the first result is the top suggestion.
*
* @param GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion[] $peopleSuggestions
*/
public function setPeopleSuggestions($peopleSuggestions)
{
$this->peopleSuggestions = $peopleSuggestions;
}
/**
* @return GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion[]
*/
public function getPeopleSuggestions()
{
return $this->peopleSuggestions;
}
/**
* Results of the matched query suggestions. The result list is ordered and
* the first result is a top suggestion.
*
* @param GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion[] $querySuggestions
*/
public function setQuerySuggestions($querySuggestions)
{
$this->querySuggestions = $querySuggestions;
}
/**
* @return GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion[]
*/
public function getQuerySuggestions()
{
return $this->querySuggestions;
}
/**
* Results of the matched "recent search" suggestions. The result list is
* ordered and the first result is the top suggestion.
*
* @param GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion[] $recentSearchSuggestions
*/
public function setRecentSearchSuggestions($recentSearchSuggestions)
{
$this->recentSearchSuggestions = $recentSearchSuggestions;
}
/**
* @return GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion[]
*/
public function getRecentSearchSuggestions()
{
return $this->recentSearchSuggestions;
}
/**
* True if the returned suggestions are all tail suggestions. For tail
* matching to be triggered, include_tail_suggestions in the request must be
* true and there must be no suggestions that match the full query.
*
* @param bool $tailMatchTriggered
*/
public function setTailMatchTriggered($tailMatchTriggered)
{
$this->tailMatchTriggered = $tailMatchTriggered;
}
/**
* @return bool
*/
public function getTailMatchTriggered()
{
return $this->tailMatchTriggered;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse');
@@ -0,0 +1,183 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion extends \Google\Model
{
/**
* Default value.
*/
public const CONTENT_TYPE_CONTENT_TYPE_UNSPECIFIED = 'CONTENT_TYPE_UNSPECIFIED';
/**
* The suggestion is from a Google Workspace source.
*/
public const CONTENT_TYPE_GOOGLE_WORKSPACE = 'GOOGLE_WORKSPACE';
/**
* The suggestion is from a third party source.
*/
public const CONTENT_TYPE_THIRD_PARTY = 'THIRD_PARTY';
/**
* The type of the content suggestion.
*
* @var string
*/
public $contentType;
/**
* The name of the dataStore that this suggestion belongs to.
*
* @var string
*/
public $dataStore;
/**
* The destination uri of the content suggestion.
*
* @var string
*/
public $destinationUri;
protected $documentType = GoogleCloudDiscoveryengineV1Document::class;
protected $documentDataType = '';
/**
* The icon uri of the content suggestion.
*
* @var string
*/
public $iconUri;
/**
* The score of each suggestion. The score is in the range of [0, 1].
*
* @var
*/
public $score;
/**
* The suggestion for the query.
*
* @var string
*/
public $suggestion;
/**
* The type of the content suggestion.
*
* Accepted values: CONTENT_TYPE_UNSPECIFIED, GOOGLE_WORKSPACE, THIRD_PARTY
*
* @param self::CONTENT_TYPE_* $contentType
*/
public function setContentType($contentType)
{
$this->contentType = $contentType;
}
/**
* @return self::CONTENT_TYPE_*
*/
public function getContentType()
{
return $this->contentType;
}
/**
* The name of the dataStore that this suggestion belongs to.
*
* @param string $dataStore
*/
public function setDataStore($dataStore)
{
$this->dataStore = $dataStore;
}
/**
* @return string
*/
public function getDataStore()
{
return $this->dataStore;
}
/**
* The destination uri of the content suggestion.
*
* @param string $destinationUri
*/
public function setDestinationUri($destinationUri)
{
$this->destinationUri = $destinationUri;
}
/**
* @return string
*/
public function getDestinationUri()
{
return $this->destinationUri;
}
/**
* The document data snippet in the suggestion. Only a subset of fields will
* be populated.
*
* @param GoogleCloudDiscoveryengineV1Document $document
*/
public function setDocument(GoogleCloudDiscoveryengineV1Document $document)
{
$this->document = $document;
}
/**
* @return GoogleCloudDiscoveryengineV1Document
*/
public function getDocument()
{
return $this->document;
}
/**
* The icon uri of the content suggestion.
*
* @param string $iconUri
*/
public function setIconUri($iconUri)
{
$this->iconUri = $iconUri;
}
/**
* @return string
*/
public function getIconUri()
{
return $this->iconUri;
}
public function setScore($score)
{
$this->score = $score;
}
public function getScore()
{
return $this->score;
}
/**
* The suggestion for the query.
*
* @param string $suggestion
*/
public function setSuggestion($suggestion)
{
$this->suggestion = $suggestion;
}
/**
* @return string
*/
public function getSuggestion()
{
return $this->suggestion;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion');
@@ -0,0 +1,184 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion extends \Google\Model
{
/**
* Default value.
*/
public const PERSON_TYPE_PERSON_TYPE_UNSPECIFIED = 'PERSON_TYPE_UNSPECIFIED';
/**
* The suggestion is from a GOOGLE_IDENTITY source.
*/
public const PERSON_TYPE_CLOUD_IDENTITY = 'CLOUD_IDENTITY';
/**
* The suggestion is from a THIRD_PARTY_IDENTITY source.
*/
public const PERSON_TYPE_THIRD_PARTY_IDENTITY = 'THIRD_PARTY_IDENTITY';
/**
* The name of the dataStore that this suggestion belongs to.
*
* @var string
*/
public $dataStore;
/**
* The destination uri of the person suggestion.
*
* @var string
*/
public $destinationUri;
/**
* The photo uri of the person suggestion.
*
* @var string
*/
public $displayPhotoUri;
protected $documentType = GoogleCloudDiscoveryengineV1Document::class;
protected $documentDataType = '';
/**
* The type of the person.
*
* @var string
*/
public $personType;
/**
* The score of each suggestion. The score is in the range of [0, 1].
*
* @var
*/
public $score;
/**
* The suggestion for the query.
*
* @var string
*/
public $suggestion;
/**
* The name of the dataStore that this suggestion belongs to.
*
* @param string $dataStore
*/
public function setDataStore($dataStore)
{
$this->dataStore = $dataStore;
}
/**
* @return string
*/
public function getDataStore()
{
return $this->dataStore;
}
/**
* The destination uri of the person suggestion.
*
* @param string $destinationUri
*/
public function setDestinationUri($destinationUri)
{
$this->destinationUri = $destinationUri;
}
/**
* @return string
*/
public function getDestinationUri()
{
return $this->destinationUri;
}
/**
* The photo uri of the person suggestion.
*
* @param string $displayPhotoUri
*/
public function setDisplayPhotoUri($displayPhotoUri)
{
$this->displayPhotoUri = $displayPhotoUri;
}
/**
* @return string
*/
public function getDisplayPhotoUri()
{
return $this->displayPhotoUri;
}
/**
* The document data snippet in the suggestion. Only a subset of fields is
* populated.
*
* @param GoogleCloudDiscoveryengineV1Document $document
*/
public function setDocument(GoogleCloudDiscoveryengineV1Document $document)
{
$this->document = $document;
}
/**
* @return GoogleCloudDiscoveryengineV1Document
*/
public function getDocument()
{
return $this->document;
}
/**
* The type of the person.
*
* Accepted values: PERSON_TYPE_UNSPECIFIED, CLOUD_IDENTITY,
* THIRD_PARTY_IDENTITY
*
* @param self::PERSON_TYPE_* $personType
*/
public function setPersonType($personType)
{
$this->personType = $personType;
}
/**
* @return self::PERSON_TYPE_*
*/
public function getPersonType()
{
return $this->personType;
}
public function setScore($score)
{
$this->score = $score;
}
public function getScore()
{
return $this->score;
}
/**
* The suggestion for the query.
*
* @param string $suggestion
*/
public function setSuggestion($suggestion)
{
$this->suggestion = $suggestion;
}
/**
* @return string
*/
public function getSuggestion()
{
return $this->suggestion;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion');
@@ -0,0 +1,111 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion extends \Google\Collection
{
protected $collection_key = 'dataStore';
/**
* The unique document field paths that serve as the source of this suggestion
* if it was generated from completable fields. This field is only populated
* for the document-completable model.
*
* @var string[]
*/
public $completableFieldPaths;
/**
* The name of the dataStore that this suggestion belongs to.
*
* @var string[]
*/
public $dataStore;
/**
* The score of each suggestion. The score is in the range of [0, 1].
*
* @var
*/
public $score;
/**
* The suggestion for the query.
*
* @var string
*/
public $suggestion;
/**
* The unique document field paths that serve as the source of this suggestion
* if it was generated from completable fields. This field is only populated
* for the document-completable model.
*
* @param string[] $completableFieldPaths
*/
public function setCompletableFieldPaths($completableFieldPaths)
{
$this->completableFieldPaths = $completableFieldPaths;
}
/**
* @return string[]
*/
public function getCompletableFieldPaths()
{
return $this->completableFieldPaths;
}
/**
* The name of the dataStore that this suggestion belongs to.
*
* @param string[] $dataStore
*/
public function setDataStore($dataStore)
{
$this->dataStore = $dataStore;
}
/**
* @return string[]
*/
public function getDataStore()
{
return $this->dataStore;
}
public function setScore($score)
{
$this->score = $score;
}
public function getScore()
{
return $this->score;
}
/**
* The suggestion for the query.
*
* @param string $suggestion
*/
public function setSuggestion($suggestion)
{
$this->suggestion = $suggestion;
}
/**
* @return string
*/
public function getSuggestion()
{
return $this->suggestion;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion');
@@ -0,0 +1,84 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion extends \Google\Model
{
/**
* The time when this recent rearch happened.
*
* @var string
*/
public $recentSearchTime;
/**
* The score of each suggestion. The score is in the range of [0, 1].
*
* @var
*/
public $score;
/**
* The suggestion for the query.
*
* @var string
*/
public $suggestion;
/**
* The time when this recent rearch happened.
*
* @param string $recentSearchTime
*/
public function setRecentSearchTime($recentSearchTime)
{
$this->recentSearchTime = $recentSearchTime;
}
/**
* @return string
*/
public function getRecentSearchTime()
{
return $this->recentSearchTime;
}
public function setScore($score)
{
$this->score = $score;
}
public function getScore()
{
return $this->score;
}
/**
* The suggestion for the query.
*
* @param string $suggestion
*/
public function setSuggestion($suggestion)
{
$this->suggestion = $suggestion;
}
/**
* @return string
*/
public function getSuggestion()
{
return $this->suggestion;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig extends \Google\Model
{
/**
* If set true, automatic refresh is disabled for the DataStore.
*
* @var bool
*/
public $disableAutomaticRefresh;
/**
* If set true, initial indexing is disabled for the DataStore.
*
* @var bool
*/
public $disableInitialIndex;
/**
* If set true, automatic refresh is disabled for the DataStore.
*
* @param bool $disableAutomaticRefresh
*/
public function setDisableAutomaticRefresh($disableAutomaticRefresh)
{
$this->disableAutomaticRefresh = $disableAutomaticRefresh;
}
/**
* @return bool
*/
public function getDisableAutomaticRefresh()
{
return $this->disableAutomaticRefresh;
}
/**
* If set true, initial indexing is disabled for the DataStore.
*
* @param bool $disableInitialIndex
*/
public function setDisableInitialIndex($disableInitialIndex)
{
$this->disableInitialIndex = $disableInitialIndex;
}
/**
* @return bool
*/
public function getDisableInitialIndex()
{
return $this->disableInitialIndex;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig');
@@ -0,0 +1,46 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AgentGatewaySetting extends \Google\Model
{
protected $defaultEgressAgentGatewayType = GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference::class;
protected $defaultEgressAgentGatewayDataType = '';
/**
* Optional. The default egress agent gateway to use, when this setting is
* applied to a Gemini Enterprise resource. The deployment mode must be
* GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE.
*
* @param GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference $defaultEgressAgentGateway
*/
public function setDefaultEgressAgentGateway(GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference $defaultEgressAgentGateway)
{
$this->defaultEgressAgentGateway = $defaultEgressAgentGateway;
}
/**
* @return GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference
*/
public function getDefaultEgressAgentGateway()
{
return $this->defaultEgressAgentGateway;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AgentGatewaySetting::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AgentGatewaySetting');
@@ -0,0 +1,52 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference extends \Google\Model
{
/**
* Required. Immutable. The resource name of the agent gateway. Expected
* format: `projects/{project_number}/locations/{location}/agentGateways/{agen
* t_gateway}`.
*
* @var string
*/
public $name;
/**
* Required. Immutable. The resource name of the agent gateway. Expected
* format: `projects/{project_number}/locations/{location}/agentGateways/{agen
* t_gateway}`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference');
@@ -0,0 +1,67 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AlertPolicyConfig extends \Google\Collection
{
protected $collection_key = 'alertEnrollments';
protected $alertEnrollmentsType = GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment::class;
protected $alertEnrollmentsDataType = 'array';
/**
* Immutable. The fully qualified resource name of the AlertPolicy.
*
* @var string
*/
public $alertPolicyName;
/**
* Optional. The enrollment states of each alert.
*
* @param GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment[] $alertEnrollments
*/
public function setAlertEnrollments($alertEnrollments)
{
$this->alertEnrollments = $alertEnrollments;
}
/**
* @return GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment[]
*/
public function getAlertEnrollments()
{
return $this->alertEnrollments;
}
/**
* Immutable. The fully qualified resource name of the AlertPolicy.
*
* @param string $alertPolicyName
*/
public function setAlertPolicyName($alertPolicyName)
{
$this->alertPolicyName = $alertPolicyName;
}
/**
* @return string
*/
public function getAlertPolicyName()
{
return $this->alertPolicyName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AlertPolicyConfig::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfig');
@@ -0,0 +1,85 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment extends \Google\Model
{
/**
* Default value. Used for customers who have not responded to the alert
* policy.
*/
public const ENROLL_STATE_ENROLL_STATES_UNSPECIFIED = 'ENROLL_STATES_UNSPECIFIED';
/**
* Customer is enrolled in this policy.
*/
public const ENROLL_STATE_ENROLLED = 'ENROLLED';
/**
* Customer declined this policy.
*/
public const ENROLL_STATE_DECLINED = 'DECLINED';
/**
* Immutable. The id of an alert.
*
* @var string
*/
public $alertId;
/**
* Required. The enrollment status of a customer.
*
* @var string
*/
public $enrollState;
/**
* Immutable. The id of an alert.
*
* @param string $alertId
*/
public function setAlertId($alertId)
{
$this->alertId = $alertId;
}
/**
* @return string
*/
public function getAlertId()
{
return $this->alertId;
}
/**
* Required. The enrollment status of a customer.
*
* Accepted values: ENROLL_STATES_UNSPECIFIED, ENROLLED, DECLINED
*
* @param self::ENROLL_STATE_* $enrollState
*/
public function setEnrollState($enrollState)
{
$this->enrollState = $enrollState;
}
/**
* @return self::ENROLL_STATE_*
*/
public function getEnrollState()
{
return $this->enrollState;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment');
@@ -0,0 +1,95 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig extends \Google\Collection
{
protected $collection_key = 'contactDetails';
protected $alertEnrollmentsType = GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment::class;
protected $alertEnrollmentsDataType = 'array';
/**
* @var string
*/
public $alertPolicy;
protected $contactDetailsType = GoogleCloudDiscoveryengineV1ContactDetails::class;
protected $contactDetailsDataType = 'array';
/**
* @var string
*/
public $languageCode;
/**
* @param GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment[]
*/
public function setAlertEnrollments($alertEnrollments)
{
$this->alertEnrollments = $alertEnrollments;
}
/**
* @return GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment[]
*/
public function getAlertEnrollments()
{
return $this->alertEnrollments;
}
/**
* @param string
*/
public function setAlertPolicy($alertPolicy)
{
$this->alertPolicy = $alertPolicy;
}
/**
* @return string
*/
public function getAlertPolicy()
{
return $this->alertPolicy;
}
/**
* @param GoogleCloudDiscoveryengineV1ContactDetails[]
*/
public function setContactDetails($contactDetails)
{
$this->contactDetails = $contactDetails;
}
/**
* @return GoogleCloudDiscoveryengineV1ContactDetails[]
*/
public function getContactDetails()
{
return $this->contactDetails;
}
/**
* @param string
*/
public function setLanguageCode($languageCode)
{
$this->languageCode = $languageCode;
}
/**
* @return string
*/
public function getLanguageCode()
{
return $this->languageCode;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig');
@@ -0,0 +1,80 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment extends \Google\Model
{
/**
* @var string
*/
public $alertId;
/**
* @var string
*/
public $enrollState;
/**
* @var string[]
*/
public $notificationParams;
/**
* @param string
*/
public function setAlertId($alertId)
{
$this->alertId = $alertId;
}
/**
* @return string
*/
public function getAlertId()
{
return $this->alertId;
}
/**
* @param string
*/
public function setEnrollState($enrollState)
{
$this->enrollState = $enrollState;
}
/**
* @return string
*/
public function getEnrollState()
{
return $this->enrollState;
}
/**
* @param string[]
*/
public function setNotificationParams($notificationParams)
{
$this->notificationParams = $notificationParams;
}
/**
* @return string[]
*/
public function getNotificationParams()
{
return $this->notificationParams;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment');
@@ -0,0 +1,178 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AlloyDbSource extends \Google\Model
{
/**
* Required. The AlloyDB cluster to copy the data from with a length limit of
* 256 characters.
*
* @var string
*/
public $clusterId;
/**
* Required. The AlloyDB database to copy the data from with a length limit of
* 256 characters.
*
* @var string
*/
public $databaseId;
/**
* 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
* AlloyDB export to a specific Cloud Storage directory. Ensure that the
* AlloyDB service account has the necessary Cloud Storage Admin permissions
* to access the specified Cloud Storage directory.
*
* @var string
*/
public $gcsStagingDir;
/**
* Required. The AlloyDB location to copy the data from with a length limit of
* 256 characters.
*
* @var string
*/
public $locationId;
/**
* The project ID that contains the AlloyDB source. Has a length limit of 128
* characters. If not specified, inherits the project ID from the parent
* request.
*
* @var string
*/
public $projectId;
/**
* Required. The AlloyDB table to copy the data from with a length limit of
* 256 characters.
*
* @var string
*/
public $tableId;
/**
* Required. The AlloyDB cluster to copy the data from with a length limit of
* 256 characters.
*
* @param string $clusterId
*/
public function setClusterId($clusterId)
{
$this->clusterId = $clusterId;
}
/**
* @return string
*/
public function getClusterId()
{
return $this->clusterId;
}
/**
* Required. The AlloyDB database to copy the data from with a length limit of
* 256 characters.
*
* @param string $databaseId
*/
public function setDatabaseId($databaseId)
{
$this->databaseId = $databaseId;
}
/**
* @return string
*/
public function getDatabaseId()
{
return $this->databaseId;
}
/**
* 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
* AlloyDB export to a specific Cloud Storage directory. Ensure that the
* AlloyDB service account has the necessary Cloud Storage Admin permissions
* to access the specified Cloud Storage directory.
*
* @param string $gcsStagingDir
*/
public function setGcsStagingDir($gcsStagingDir)
{
$this->gcsStagingDir = $gcsStagingDir;
}
/**
* @return string
*/
public function getGcsStagingDir()
{
return $this->gcsStagingDir;
}
/**
* Required. The AlloyDB location to copy the data from with a length limit of
* 256 characters.
*
* @param string $locationId
*/
public function setLocationId($locationId)
{
$this->locationId = $locationId;
}
/**
* @return string
*/
public function getLocationId()
{
return $this->locationId;
}
/**
* The project ID that contains the AlloyDB source. Has a length limit of 128
* characters. If not specified, inherits the project ID from the parent
* request.
*
* @param string $projectId
*/
public function setProjectId($projectId)
{
$this->projectId = $projectId;
}
/**
* @return string
*/
public function getProjectId()
{
return $this->projectId;
}
/**
* Required. The AlloyDB table to copy the data from with a length limit of
* 256 characters.
*
* @param string $tableId
*/
public function setTableId($tableId)
{
$this->tableId = $tableId;
}
/**
* @return string
*/
public function getTableId()
{
return $this->tableId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AlloyDbSource::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AlloyDbSource');
@@ -0,0 +1,331 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1Answer extends \Google\Collection
{
/**
* Unknown.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* Answer generation is currently in progress.
*/
public const STATE_IN_PROGRESS = 'IN_PROGRESS';
/**
* Answer generation currently failed.
*/
public const STATE_FAILED = 'FAILED';
/**
* Answer generation has succeeded.
*/
public const STATE_SUCCEEDED = 'SUCCEEDED';
/**
* Answer generation is currently in progress.
*/
public const STATE_STREAMING = 'STREAMING';
protected $collection_key = 'steps';
/**
* Additional answer-skipped reasons. This provides the reason for ignored
* cases. If nothing is skipped, this field is not set.
*
* @var string[]
*/
public $answerSkippedReasons;
/**
* The textual answer.
*
* @var string
*/
public $answerText;
protected $citationsType = GoogleCloudDiscoveryengineV1AnswerCitation::class;
protected $citationsDataType = 'array';
/**
* Output only. Answer completed timestamp.
*
* @var string
*/
public $completeTime;
/**
* Output only. Answer creation timestamp.
*
* @var string
*/
public $createTime;
/**
* A score in the range of [0, 1] describing how grounded the answer is by the
* reference chunks.
*
* @var
*/
public $groundingScore;
protected $groundingSupportsType = GoogleCloudDiscoveryengineV1AnswerGroundingSupport::class;
protected $groundingSupportsDataType = 'array';
/**
* Immutable. Fully qualified name `projects/{project}/locations/global/collec
* tions/{collection}/engines/{engine}/sessions/answers`
*
* @var string
*/
public $name;
protected $queryUnderstandingInfoType = GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo::class;
protected $queryUnderstandingInfoDataType = '';
protected $referencesType = GoogleCloudDiscoveryengineV1AnswerReference::class;
protected $referencesDataType = 'array';
/**
* Suggested related questions.
*
* @var string[]
*/
public $relatedQuestions;
protected $safetyRatingsType = GoogleCloudDiscoveryengineV1SafetyRating::class;
protected $safetyRatingsDataType = 'array';
/**
* The state of the answer generation.
*
* @var string
*/
public $state;
protected $stepsType = GoogleCloudDiscoveryengineV1AnswerStep::class;
protected $stepsDataType = 'array';
/**
* Additional answer-skipped reasons. This provides the reason for ignored
* cases. If nothing is skipped, this field is not set.
*
* @param string[] $answerSkippedReasons
*/
public function setAnswerSkippedReasons($answerSkippedReasons)
{
$this->answerSkippedReasons = $answerSkippedReasons;
}
/**
* @return string[]
*/
public function getAnswerSkippedReasons()
{
return $this->answerSkippedReasons;
}
/**
* The textual answer.
*
* @param string $answerText
*/
public function setAnswerText($answerText)
{
$this->answerText = $answerText;
}
/**
* @return string
*/
public function getAnswerText()
{
return $this->answerText;
}
/**
* Citations.
*
* @param GoogleCloudDiscoveryengineV1AnswerCitation[] $citations
*/
public function setCitations($citations)
{
$this->citations = $citations;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerCitation[]
*/
public function getCitations()
{
return $this->citations;
}
/**
* Output only. Answer completed timestamp.
*
* @param string $completeTime
*/
public function setCompleteTime($completeTime)
{
$this->completeTime = $completeTime;
}
/**
* @return string
*/
public function getCompleteTime()
{
return $this->completeTime;
}
/**
* Output only. Answer creation timestamp.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
public function setGroundingScore($groundingScore)
{
$this->groundingScore = $groundingScore;
}
public function getGroundingScore()
{
return $this->groundingScore;
}
/**
* Optional. Grounding supports.
*
* @param GoogleCloudDiscoveryengineV1AnswerGroundingSupport[] $groundingSupports
*/
public function setGroundingSupports($groundingSupports)
{
$this->groundingSupports = $groundingSupports;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerGroundingSupport[]
*/
public function getGroundingSupports()
{
return $this->groundingSupports;
}
/**
* Immutable. Fully qualified name `projects/{project}/locations/global/collec
* tions/{collection}/engines/{engine}/sessions/answers`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Query understanding information.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo $queryUnderstandingInfo
*/
public function setQueryUnderstandingInfo(GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo $queryUnderstandingInfo)
{
$this->queryUnderstandingInfo = $queryUnderstandingInfo;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo
*/
public function getQueryUnderstandingInfo()
{
return $this->queryUnderstandingInfo;
}
/**
* References.
*
* @param GoogleCloudDiscoveryengineV1AnswerReference[] $references
*/
public function setReferences($references)
{
$this->references = $references;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerReference[]
*/
public function getReferences()
{
return $this->references;
}
/**
* Suggested related questions.
*
* @param string[] $relatedQuestions
*/
public function setRelatedQuestions($relatedQuestions)
{
$this->relatedQuestions = $relatedQuestions;
}
/**
* @return string[]
*/
public function getRelatedQuestions()
{
return $this->relatedQuestions;
}
/**
* Optional. Safety ratings.
*
* @param GoogleCloudDiscoveryengineV1SafetyRating[] $safetyRatings
*/
public function setSafetyRatings($safetyRatings)
{
$this->safetyRatings = $safetyRatings;
}
/**
* @return GoogleCloudDiscoveryengineV1SafetyRating[]
*/
public function getSafetyRatings()
{
return $this->safetyRatings;
}
/**
* The state of the answer generation.
*
* Accepted values: STATE_UNSPECIFIED, IN_PROGRESS, FAILED, SUCCEEDED,
* STREAMING
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Answer generation steps.
*
* @param GoogleCloudDiscoveryengineV1AnswerStep[] $steps
*/
public function setSteps($steps)
{
$this->steps = $steps;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerStep[]
*/
public function getSteps()
{
return $this->steps;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1Answer::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1Answer');
@@ -0,0 +1,97 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerCitation extends \Google\Collection
{
protected $collection_key = 'sources';
/**
* End of the attributed segment, exclusive. Measured in bytes (UTF-8
* unicode). If there are multi-byte characters,such as non-ASCII characters,
* the index measurement is longer than the string length.
*
* @var string
*/
public $endIndex;
protected $sourcesType = GoogleCloudDiscoveryengineV1AnswerCitationSource::class;
protected $sourcesDataType = 'array';
/**
* Index indicates the start of the segment, measured in bytes (UTF-8
* unicode). If there are multi-byte characters,such as non-ASCII characters,
* the index measurement is longer than the string length.
*
* @var string
*/
public $startIndex;
/**
* End of the attributed segment, exclusive. Measured in bytes (UTF-8
* unicode). If there are multi-byte characters,such as non-ASCII characters,
* the index measurement is longer than the string length.
*
* @param string $endIndex
*/
public function setEndIndex($endIndex)
{
$this->endIndex = $endIndex;
}
/**
* @return string
*/
public function getEndIndex()
{
return $this->endIndex;
}
/**
* Citation sources for the attributed segment.
*
* @param GoogleCloudDiscoveryengineV1AnswerCitationSource[] $sources
*/
public function setSources($sources)
{
$this->sources = $sources;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerCitationSource[]
*/
public function getSources()
{
return $this->sources;
}
/**
* Index indicates the start of the segment, measured in bytes (UTF-8
* unicode). If there are multi-byte characters,such as non-ASCII characters,
* the index measurement is longer than the string length.
*
* @param string $startIndex
*/
public function setStartIndex($startIndex)
{
$this->startIndex = $startIndex;
}
/**
* @return string
*/
public function getStartIndex()
{
return $this->startIndex;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerCitation::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerCitation');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerCitationSource extends \Google\Model
{
/**
* ID of the citation source.
*
* @var string
*/
public $referenceId;
/**
* ID of the citation source.
*
* @param string $referenceId
*/
public function setReferenceId($referenceId)
{
$this->referenceId = $referenceId;
}
/**
* @return string
*/
public function getReferenceId()
{
return $this->referenceId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerCitationSource::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerCitationSource');
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerGenerationSpec extends \Google\Model
{
protected $userDefinedClassifierSpecType = GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec::class;
protected $userDefinedClassifierSpecDataType = '';
/**
* Optional. The specification for user specified classifier spec.
*
* @param GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec $userDefinedClassifierSpec
*/
public function setUserDefinedClassifierSpec(GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec $userDefinedClassifierSpec)
{
$this->userDefinedClassifierSpec = $userDefinedClassifierSpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec
*/
public function getUserDefinedClassifierSpec()
{
return $this->userDefinedClassifierSpec;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerGenerationSpec::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerGenerationSpec');
@@ -0,0 +1,186 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec extends \Google\Model
{
/**
* Optional. Whether or not to enable and include user defined classifier.
*
* @var bool
*/
public $enableUserDefinedClassifier;
/**
* Optional. The model id to be used for the user defined classifier.
*
* @var string
*/
public $modelId;
/**
* Optional. The preamble to be used for the user defined classifier.
*
* @var string
*/
public $preamble;
/**
* Optional. The seed value to be used for the user defined classifier.
*
* @var int
*/
public $seed;
/**
* Optional. The task marker to be used for the user defined classifier.
*
* @var string
*/
public $taskMarker;
/**
* Optional. The temperature value to be used for the user defined classifier.
*
* @var
*/
public $temperature;
/**
* Optional. The top-k value to be used for the user defined classifier.
*
* @var string
*/
public $topK;
/**
* Optional. The top-p value to be used for the user defined classifier.
*
* @var
*/
public $topP;
/**
* Optional. Whether or not to enable and include user defined classifier.
*
* @param bool $enableUserDefinedClassifier
*/
public function setEnableUserDefinedClassifier($enableUserDefinedClassifier)
{
$this->enableUserDefinedClassifier = $enableUserDefinedClassifier;
}
/**
* @return bool
*/
public function getEnableUserDefinedClassifier()
{
return $this->enableUserDefinedClassifier;
}
/**
* Optional. The model id to be used for the user defined classifier.
*
* @param string $modelId
*/
public function setModelId($modelId)
{
$this->modelId = $modelId;
}
/**
* @return string
*/
public function getModelId()
{
return $this->modelId;
}
/**
* Optional. The preamble to be used for the user defined classifier.
*
* @param string $preamble
*/
public function setPreamble($preamble)
{
$this->preamble = $preamble;
}
/**
* @return string
*/
public function getPreamble()
{
return $this->preamble;
}
/**
* Optional. The seed value to be used for the user defined classifier.
*
* @param int $seed
*/
public function setSeed($seed)
{
$this->seed = $seed;
}
/**
* @return int
*/
public function getSeed()
{
return $this->seed;
}
/**
* Optional. The task marker to be used for the user defined classifier.
*
* @param string $taskMarker
*/
public function setTaskMarker($taskMarker)
{
$this->taskMarker = $taskMarker;
}
/**
* @return string
*/
public function getTaskMarker()
{
return $this->taskMarker;
}
public function setTemperature($temperature)
{
$this->temperature = $temperature;
}
public function getTemperature()
{
return $this->temperature;
}
/**
* Optional. The top-k value to be used for the user defined classifier.
*
* @param string $topK
*/
public function setTopK($topK)
{
$this->topK = $topK;
}
/**
* @return string
*/
public function getTopK()
{
return $this->topK;
}
public function setTopP($topP)
{
$this->topP = $topP;
}
public function getTopP()
{
return $this->topP;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec');
@@ -0,0 +1,135 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerGroundingSupport extends \Google\Collection
{
protected $collection_key = 'sources';
/**
* Required. End of the claim, exclusive.
*
* @var string
*/
public $endIndex;
/**
* Indicates that this claim required grounding check. When the system decided
* this claim didn't require attribution/grounding check, this field is set to
* false. In that case, no grounding check was done for the claim and
* therefore `grounding_score`, `sources` is not returned.
*
* @var bool
*/
public $groundingCheckRequired;
/**
* A score in the range of [0, 1] describing how grounded is a specific claim
* by the references. Higher value means that the claim is better supported by
* the reference chunks.
*
* @var
*/
public $groundingScore;
protected $sourcesType = GoogleCloudDiscoveryengineV1AnswerCitationSource::class;
protected $sourcesDataType = 'array';
/**
* Required. Index indicates the start of the claim, measured in bytes (UTF-8
* unicode).
*
* @var string
*/
public $startIndex;
/**
* Required. End of the claim, exclusive.
*
* @param string $endIndex
*/
public function setEndIndex($endIndex)
{
$this->endIndex = $endIndex;
}
/**
* @return string
*/
public function getEndIndex()
{
return $this->endIndex;
}
/**
* Indicates that this claim required grounding check. When the system decided
* this claim didn't require attribution/grounding check, this field is set to
* false. In that case, no grounding check was done for the claim and
* therefore `grounding_score`, `sources` is not returned.
*
* @param bool $groundingCheckRequired
*/
public function setGroundingCheckRequired($groundingCheckRequired)
{
$this->groundingCheckRequired = $groundingCheckRequired;
}
/**
* @return bool
*/
public function getGroundingCheckRequired()
{
return $this->groundingCheckRequired;
}
public function setGroundingScore($groundingScore)
{
$this->groundingScore = $groundingScore;
}
public function getGroundingScore()
{
return $this->groundingScore;
}
/**
* Optional. Citation sources for the claim.
*
* @param GoogleCloudDiscoveryengineV1AnswerCitationSource[] $sources
*/
public function setSources($sources)
{
$this->sources = $sources;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerCitationSource[]
*/
public function getSources()
{
return $this->sources;
}
/**
* Required. Index indicates the start of the claim, measured in bytes (UTF-8
* unicode).
*
* @param string $startIndex
*/
public function setStartIndex($startIndex)
{
$this->startIndex = $startIndex;
}
/**
* @return string
*/
public function getStartIndex()
{
return $this->startIndex;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerGroundingSupport::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerGroundingSupport');
@@ -0,0 +1,311 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerQueryRequest extends \Google\Model
{
protected $answerGenerationSpecType = GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec::class;
protected $answerGenerationSpecDataType = '';
/**
* Deprecated: This field is deprecated. Streaming Answer API will be
* supported. Asynchronous mode control. If enabled, the response will be
* returned with answer/session resource name without final answer. The API
* users need to do the polling to get the latest status of answer/session by
* calling ConversationalSearchService.GetAnswer or
* ConversationalSearchService.GetSession method.
*
* @deprecated
* @var bool
*/
public $asynchronousMode;
protected $endUserSpecType = GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec::class;
protected $endUserSpecDataType = '';
protected $groundingSpecType = GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec::class;
protected $groundingSpecDataType = '';
protected $queryType = GoogleCloudDiscoveryengineV1Query::class;
protected $queryDataType = '';
protected $queryUnderstandingSpecType = GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec::class;
protected $queryUnderstandingSpecDataType = '';
protected $relatedQuestionsSpecType = GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec::class;
protected $relatedQuestionsSpecDataType = '';
protected $safetySpecType = GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec::class;
protected $safetySpecDataType = '';
protected $searchSpecType = GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec::class;
protected $searchSpecDataType = '';
/**
* The session resource name. Not required. When session field is not set, the
* API is in sessionless mode. We support auto session mode: users can use the
* wildcard symbol `-` as session ID. A new ID will be automatically generated
* and assigned.
*
* @var string
*/
public $session;
/**
* 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 [Google Cloud
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-
* labels#requirements) for more details.
*
* @var string[]
*/
public $userLabels;
/**
* 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 logs in or out of the website. This field should NOT have a
* fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded
* string with a length limit of 128 characters. Otherwise, an
* `INVALID_ARGUMENT` error is returned.
*
* @var string
*/
public $userPseudoId;
/**
* Answer generation specification.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec $answerGenerationSpec
*/
public function setAnswerGenerationSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec $answerGenerationSpec)
{
$this->answerGenerationSpec = $answerGenerationSpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec
*/
public function getAnswerGenerationSpec()
{
return $this->answerGenerationSpec;
}
/**
* Deprecated: This field is deprecated. Streaming Answer API will be
* supported. Asynchronous mode control. If enabled, the response will be
* returned with answer/session resource name without final answer. The API
* users need to do the polling to get the latest status of answer/session by
* calling ConversationalSearchService.GetAnswer or
* ConversationalSearchService.GetSession method.
*
* @deprecated
* @param bool $asynchronousMode
*/
public function setAsynchronousMode($asynchronousMode)
{
$this->asynchronousMode = $asynchronousMode;
}
/**
* @deprecated
* @return bool
*/
public function getAsynchronousMode()
{
return $this->asynchronousMode;
}
/**
* Optional. End user specification.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec $endUserSpec
*/
public function setEndUserSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec $endUserSpec)
{
$this->endUserSpec = $endUserSpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec
*/
public function getEndUserSpec()
{
return $this->endUserSpec;
}
/**
* Optional. Grounding specification.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec $groundingSpec
*/
public function setGroundingSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec $groundingSpec)
{
$this->groundingSpec = $groundingSpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec
*/
public function getGroundingSpec()
{
return $this->groundingSpec;
}
/**
* Required. Current user query.
*
* @param GoogleCloudDiscoveryengineV1Query $query
*/
public function setQuery(GoogleCloudDiscoveryengineV1Query $query)
{
$this->query = $query;
}
/**
* @return GoogleCloudDiscoveryengineV1Query
*/
public function getQuery()
{
return $this->query;
}
/**
* Query understanding specification.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec $queryUnderstandingSpec
*/
public function setQueryUnderstandingSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec $queryUnderstandingSpec)
{
$this->queryUnderstandingSpec = $queryUnderstandingSpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec
*/
public function getQueryUnderstandingSpec()
{
return $this->queryUnderstandingSpec;
}
/**
* Related questions specification.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec $relatedQuestionsSpec
*/
public function setRelatedQuestionsSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec $relatedQuestionsSpec)
{
$this->relatedQuestionsSpec = $relatedQuestionsSpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec
*/
public function getRelatedQuestionsSpec()
{
return $this->relatedQuestionsSpec;
}
/**
* Model specification.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec $safetySpec
*/
public function setSafetySpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec $safetySpec)
{
$this->safetySpec = $safetySpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec
*/
public function getSafetySpec()
{
return $this->safetySpec;
}
/**
* Search specification.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec $searchSpec
*/
public function setSearchSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec $searchSpec)
{
$this->searchSpec = $searchSpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec
*/
public function getSearchSpec()
{
return $this->searchSpec;
}
/**
* The session resource name. Not required. When session field is not set, the
* API is in sessionless mode. We support auto session mode: users can use the
* wildcard symbol `-` as session ID. A new ID will be automatically generated
* and assigned.
*
* @param string $session
*/
public function setSession($session)
{
$this->session = $session;
}
/**
* @return string
*/
public function getSession()
{
return $this->session;
}
/**
* 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 [Google Cloud
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-
* labels#requirements) for more details.
*
* @param string[] $userLabels
*/
public function setUserLabels($userLabels)
{
$this->userLabels = $userLabels;
}
/**
* @return string[]
*/
public function getUserLabels()
{
return $this->userLabels;
}
/**
* 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 logs in or out of the website. This field should NOT have a
* fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded
* string with a length limit of 128 characters. Otherwise, an
* `INVALID_ARGUMENT` error is returned.
*
* @param string $userPseudoId
*/
public function setUserPseudoId($userPseudoId)
{
$this->userPseudoId = $userPseudoId;
}
/**
* @return string
*/
public function getUserPseudoId()
{
return $this->userPseudoId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerQueryRequest::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerQueryRequest');
@@ -0,0 +1,246 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec extends \Google\Model
{
/**
* Language code for Answer. Use language tags defined by
* [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an
* experimental feature.
*
* @var string
*/
public $answerLanguageCode;
/**
* Specifies whether to filter out adversarial queries. The default value is
* `false`. Google employs search-query classification to detect adversarial
* queries. No answer is returned if the search query is classified as an
* adversarial query. For example, a user might ask a question regarding
* negative comments about the company or submit a query designed to generate
* unsafe, policy-violating output. If this field is set to `true`, we skip
* generating answers for adversarial queries and return fallback messages
* instead.
*
* @var bool
*/
public $ignoreAdversarialQuery;
/**
* Optional. Specifies whether to filter out jail-breaking queries. The
* default value is `false`. Google employs search-query classification to
* detect jail-breaking queries. No summary is returned if the search query is
* classified as a jail-breaking query. A user might add instructions to the
* query to change the tone, style, language, content of the answer, or ask
* the model to act as a different entity, e.g. "Reply in the tone of a
* competing company's CEO". If this field is set to `true`, we skip
* generating summaries for jail-breaking queries and return fallback messages
* instead.
*
* @var bool
*/
public $ignoreJailBreakingQuery;
/**
* Specifies whether to filter out queries that have low relevance. If this
* field is set to `false`, all search results are used regardless of
* relevance to generate answers. If set to `true` or unset, the behavior will
* be determined automatically by the service.
*
* @var bool
*/
public $ignoreLowRelevantContent;
/**
* Specifies whether to filter out queries that are not answer-seeking. The
* default value is `false`. Google employs search-query classification to
* detect answer-seeking queries. No answer is returned if the search query is
* classified as a non-answer seeking query. If this field is set to `true`,
* we skip generating answers for non-answer seeking queries and return
* fallback messages instead.
*
* @var bool
*/
public $ignoreNonAnswerSeekingQuery;
/**
* Specifies whether to include citation metadata in the answer. The default
* value is `false`.
*
* @var bool
*/
public $includeCitations;
protected $modelSpecType = GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec::class;
protected $modelSpecDataType = '';
protected $promptSpecType = GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec::class;
protected $promptSpecDataType = '';
/**
* Language code for Answer. Use language tags defined by
* [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an
* experimental feature.
*
* @param string $answerLanguageCode
*/
public function setAnswerLanguageCode($answerLanguageCode)
{
$this->answerLanguageCode = $answerLanguageCode;
}
/**
* @return string
*/
public function getAnswerLanguageCode()
{
return $this->answerLanguageCode;
}
/**
* Specifies whether to filter out adversarial queries. The default value is
* `false`. Google employs search-query classification to detect adversarial
* queries. No answer is returned if the search query is classified as an
* adversarial query. For example, a user might ask a question regarding
* negative comments about the company or submit a query designed to generate
* unsafe, policy-violating output. If this field is set to `true`, we skip
* generating answers for adversarial queries and return fallback messages
* instead.
*
* @param bool $ignoreAdversarialQuery
*/
public function setIgnoreAdversarialQuery($ignoreAdversarialQuery)
{
$this->ignoreAdversarialQuery = $ignoreAdversarialQuery;
}
/**
* @return bool
*/
public function getIgnoreAdversarialQuery()
{
return $this->ignoreAdversarialQuery;
}
/**
* Optional. Specifies whether to filter out jail-breaking queries. The
* default value is `false`. Google employs search-query classification to
* detect jail-breaking queries. No summary is returned if the search query is
* classified as a jail-breaking query. A user might add instructions to the
* query to change the tone, style, language, content of the answer, or ask
* the model to act as a different entity, e.g. "Reply in the tone of a
* competing company's CEO". If this field is set to `true`, we skip
* generating summaries for jail-breaking queries and return fallback messages
* instead.
*
* @param bool $ignoreJailBreakingQuery
*/
public function setIgnoreJailBreakingQuery($ignoreJailBreakingQuery)
{
$this->ignoreJailBreakingQuery = $ignoreJailBreakingQuery;
}
/**
* @return bool
*/
public function getIgnoreJailBreakingQuery()
{
return $this->ignoreJailBreakingQuery;
}
/**
* Specifies whether to filter out queries that have low relevance. If this
* field is set to `false`, all search results are used regardless of
* relevance to generate answers. If set to `true` or unset, the behavior will
* be determined automatically by the service.
*
* @param bool $ignoreLowRelevantContent
*/
public function setIgnoreLowRelevantContent($ignoreLowRelevantContent)
{
$this->ignoreLowRelevantContent = $ignoreLowRelevantContent;
}
/**
* @return bool
*/
public function getIgnoreLowRelevantContent()
{
return $this->ignoreLowRelevantContent;
}
/**
* Specifies whether to filter out queries that are not answer-seeking. The
* default value is `false`. Google employs search-query classification to
* detect answer-seeking queries. No answer is returned if the search query is
* classified as a non-answer seeking query. If this field is set to `true`,
* we skip generating answers for non-answer seeking queries and return
* fallback messages instead.
*
* @param bool $ignoreNonAnswerSeekingQuery
*/
public function setIgnoreNonAnswerSeekingQuery($ignoreNonAnswerSeekingQuery)
{
$this->ignoreNonAnswerSeekingQuery = $ignoreNonAnswerSeekingQuery;
}
/**
* @return bool
*/
public function getIgnoreNonAnswerSeekingQuery()
{
return $this->ignoreNonAnswerSeekingQuery;
}
/**
* Specifies whether to include citation metadata in the answer. The default
* value is `false`.
*
* @param bool $includeCitations
*/
public function setIncludeCitations($includeCitations)
{
$this->includeCitations = $includeCitations;
}
/**
* @return bool
*/
public function getIncludeCitations()
{
return $this->includeCitations;
}
/**
* Answer generation model specification.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec $modelSpec
*/
public function setModelSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec $modelSpec)
{
$this->modelSpec = $modelSpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec
*/
public function getModelSpec()
{
return $this->modelSpec;
}
/**
* Answer generation prompt specification.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec $promptSpec
*/
public function setPromptSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec $promptSpec)
{
$this->promptSpec = $promptSpec;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec
*/
public function getPromptSpec()
{
return $this->promptSpec;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec');
@@ -0,0 +1,50 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec extends \Google\Model
{
/**
* Model version. If not set, it will use the default stable model. Allowed
* values are: stable, preview.
*
* @var string
*/
public $modelVersion;
/**
* Model version. If not set, it will use the default stable model. Allowed
* values are: stable, preview.
*
* @param string $modelVersion
*/
public function setModelVersion($modelVersion)
{
$this->modelVersion = $modelVersion;
}
/**
* @return string
*/
public function getModelVersion()
{
return $this->modelVersion;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec extends \Google\Model
{
/**
* Customized preamble.
*
* @var string
*/
public $preamble;
/**
* Customized preamble.
*
* @param string $preamble
*/
public function setPreamble($preamble)
{
$this->preamble = $preamble;
}
/**
* @return string
*/
public function getPreamble()
{
return $this->preamble;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec extends \Google\Collection
{
protected $collection_key = 'endUserMetadata';
protected $endUserMetadataType = GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData::class;
protected $endUserMetadataDataType = 'array';
/**
* Optional. End user metadata.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData[] $endUserMetadata
*/
public function setEndUserMetadata($endUserMetadata)
{
$this->endUserMetadata = $endUserMetadata;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData[]
*/
public function getEndUserMetadata()
{
return $this->endUserMetadata;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec');
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData extends \Google\Model
{
protected $chunkInfoType = GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo::class;
protected $chunkInfoDataType = '';
/**
* Chunk information.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo $chunkInfo
*/
public function setChunkInfo(GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo $chunkInfo)
{
$this->chunkInfo = $chunkInfo;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo
*/
public function getChunkInfo()
{
return $this->chunkInfo;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData');
@@ -0,0 +1,66 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo extends \Google\Model
{
/**
* Chunk textual content. It is limited to 8000 characters.
*
* @var string
*/
public $content;
protected $documentMetadataType = GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata::class;
protected $documentMetadataDataType = '';
/**
* Chunk textual content. It is limited to 8000 characters.
*
* @param string $content
*/
public function setContent($content)
{
$this->content = $content;
}
/**
* @return string
*/
public function getContent()
{
return $this->content;
}
/**
* Metadata of the document from the current chunk.
*
* @param GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata $documentMetadata
*/
public function setDocumentMetadata(GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata $documentMetadata)
{
$this->documentMetadata = $documentMetadata;
}
/**
* @return GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata
*/
public function getDocumentMetadata()
{
return $this->documentMetadata;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo');

Some files were not shown because too many files have changed in this diff Show More