class DeployedFleet(proto.Message):
r"""Agones fleet specification and details.
Attributes:
fleet (str):
The name of the Agones fleet.
fleet_spec (str):
The fleet spec retrieved from the Agones
fleet.
spec_source (google.cloud.gaming_v1beta.types.SpecSource):
The source spec that is used to create the
Agones fleet. The GameServerConfig resource may
no longer exist in the system.
status (google.cloud.gaming_v1beta.types.DeployedFleetDetails.DeployedFleet.DeployedFleetStatus):
The current status of the Agones fleet.
Includes count of game servers in various
states.
"""
class DeployedFleetStatus(proto.Message):
r"""DeployedFleetStatus has details about the Agones fleets such
as how many are running, how many allocated, and so on.
Attributes:
ready_replicas (int):
The number of GameServer replicas in the
READY state in this fleet.
allocated_replicas (int):
The number of GameServer replicas in the
ALLOCATED state in this fleet.
reserved_replicas (int):
The number of GameServer replicas in the
RESERVED state in this fleet. Reserved instances
won't be deleted on scale down, but won't cause
an autoscaler to scale up.
replicas (int):
The total number of current GameServer
replicas in this fleet.
"""
ready_replicas = proto.Field(
proto.INT64,
number=1,
)
allocated_replicas = proto.Field(
proto.INT64,
number=2,
)
reserved_replicas = proto.Field(
proto.INT64,
number=3,
)
replicas = proto.Field(
proto.INT64,
number=4,
)
fleet = proto.Field(
proto.STRING,
number=1,
)
fleet_spec = proto.Field(
proto.STRING,
number=2,
)
spec_source = proto.Field(
proto.MESSAGE,
number=3,
message="SpecSource",
)
status = proto.Field(
proto.MESSAGE,
number=5,
message="DeployedFleetDetails.DeployedFleet.DeployedFleetStatus",
)
class FacetKey(proto.Message):
r"""Specifies how a facet is computed.
Attributes:
key (str):
Required. Supported textual and numerical facet keys in
[Product][google.cloud.retail.v2.Product] object, over which
the facet values are computed. Facet key is case-sensitive.
Allowed facet keys when
[FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
is not specified:
- textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
- numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,attributes.key)".
intervals (Sequence[google.cloud.retail_v2.types.Interval]):
Set only if values should be bucketized into
intervals. Must be set for facets with numerical
values. Must not be set for facet with text
values. Maximum number of intervals is 30.
restricted_values (Sequence[str]):
Only get facet for the given restricted values. For example,
when using "pickupInStore" as key and set restricted values
to ["store123", "store456"], only facets for "store123" and
"store456" are returned. Only supported on textual fields
and fulfillments. Maximum is 20.
Must be set for the fulfillment facet keys:
- pickupInStore
- shipToStore
- sameDayDelivery
- nextDayDelivery
- customFulfillment1
- customFulfillment2
- customFulfillment3
- customFulfillment4
- customFulfillment5
prefixes (Sequence[str]):
Only get facet values that start with the
given string prefix. For example, suppose
"categories" has three values "Women > Shoe",
"Women > Dress" and "Men > Shoe". If set
"prefixes" to "Women", the "categories" facet
will give only "Women > Shoe" and "Women >
Dress". Only supported on textual fields.
Maximum is 10.
contains (Sequence[str]):
Only get facet values that contains the given
strings. For example, suppose "categories" has
three values "Women > Shoe", "Women > Dress" and
"Men > Shoe". If set "contains" to "Shoe", the
"categories" facet will give only "Women > Shoe"
and "Men > Shoe". Only supported on textual
fields. Maximum is 10.
order_by (str):
The order in which [Facet.values][] are returned.
Allowed values are:
- "count desc", which means order by
[Facet.FacetValue.count][] descending.
- "value desc", which means order by
[Facet.FacetValue.value][] descending. Only applies to
textual facets.
If not set, textual values are sorted in `natural
order <https://en.wikipedia.org/wiki/Natural_sort_order>`__;
numerical intervals are sorted in the order given by
[FacetSpec.FacetKey.intervals][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.intervals];
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
are sorted in the order given by
[FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.restricted_values].
query (str):
The query that is used to compute facet for the given facet
key. When provided, it will override the default behavior of
facet computation. The query syntax is the same as a filter
expression. See
[SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]
for detail syntax and limitations. Notice that there is no
limitation on
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
when query is specified.
In the response, [FacetValue.value][] will be always "1" and
[FacetValue.count][] will be the number of results that
matches the query.
For example, you can set a customized facet for
"shipToStore", where
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is "customizedShipToStore", and
[FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
is "availability: ANY("IN_STOCK") AND shipToStore:
ANY("123")". Then the facet will count the products that are
both in stock and ship to store "123".
"""
key = proto.Field(
proto.STRING,
number=1,
)
intervals = proto.RepeatedField(
proto.MESSAGE,
number=2,
message=common.Interval,
)
restricted_values = proto.RepeatedField(
proto.STRING,
number=3,
)
prefixes = proto.RepeatedField(
proto.STRING,
number=8,
)
contains = proto.RepeatedField(
proto.STRING,
number=9,
)
order_by = proto.Field(
proto.STRING,
number=4,
)
query = proto.Field(
proto.STRING,
number=5,
)
class SearchResult(proto.Message):
r"""Represents the search results.
Attributes:
id (str):
[Product.id][google.cloud.retail.v2.Product.id] of the
searched [Product][google.cloud.retail.v2.Product].
product (google.cloud.retail_v2.types.Product):
The product data snippet in the search response. Only
[Product.name][google.cloud.retail.v2.Product.name] is
guaranteed to be populated.
[Product.variants][google.cloud.retail.v2.Product.variants]
contains the product variants that match the search query.
If there are multiple product variants matching the query,
top 5 most relevant product variants are returned and
ordered by relevancy.
If relevancy can be deternmined, use
[matching_variant_fields][google.cloud.retail.v2.SearchResponse.SearchResult.matching_variant_fields]
to look up matched product variants fields. If relevancy
cannot be determined, e.g. when searching "shoe" all
products in a shoe product can be a match, 5 product
variants are returned but order is meaningless.
matching_variant_count (int):
The count of matched
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product]s.
matching_variant_fields (Sequence[google.cloud.retail_v2.types.SearchResponse.SearchResult.MatchingVariantFieldsEntry]):
If a [variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product] matches the search
query, this map indicates which
[Product][google.cloud.retail.v2.Product] fields are
matched. The key is the
[Product.name][google.cloud.retail.v2.Product.name], the
value is a field mask of the matched
[Product][google.cloud.retail.v2.Product] fields. If matched
attributes cannot be determined, this map will be empty.
For example, a key "sku1" with field mask
"products.color_info" indicates there is a match between
"sku1" [ColorInfo][google.cloud.retail.v2.ColorInfo] and the
query.
variant_rollup_values (Sequence[google.cloud.retail_v2.types.SearchResponse.SearchResult.VariantRollupValuesEntry]):
The rollup matching
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product] attributes. The
key is one of the
[SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
The values are the merged and de-duplicated
[Product][google.cloud.retail.v2.Product] attributes. Notice
that the rollup values are respect filter. For example, when
filtering by "colorFamilies:ANY("red")" and rollup
"colorFamilies", only "red" is returned.
For textual and numerical attributes, the rollup values is a
list of string or double values with type
[google.protobuf.ListValue][google.protobuf.ListValue]. For
example, if there are two variants with colors "red" and
"blue", the rollup values are
::
{ key: "colorFamilies"
value {
list_value {
values { string_value: "red" }
values { string_value: "blue" }
}
}
}
For
[FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo],
the rollup values is a double value with type
[google.protobuf.Value][google.protobuf.Value]. For example,
``{key: "pickupInStore.store1" value { number_value: 10 }}``
means a there are 10 variants in this product are available
in the store "store1".
"""
id = proto.Field(
proto.STRING,
number=1,
)
product = proto.Field(
proto.MESSAGE,
number=2,
message=gcr_product.Product,
)
matching_variant_count = proto.Field(
proto.INT32,
number=3,
)
matching_variant_fields = proto.MapField(
proto.STRING,
proto.MESSAGE,
number=4,
message=field_mask_pb2.FieldMask,
)
variant_rollup_values = proto.MapField(
proto.STRING,
proto.MESSAGE,
number=5,
message=struct_pb2.Value,
)
class PushConfig(proto.Message):
r"""Configuration for a push delivery endpoint.
Attributes:
push_endpoint (str):
A URL locating the endpoint to which messages
should be pushed. For example, a Webhook
endpoint might use "https://example.com/push".
attributes (Sequence[~.pubsub.PushConfig.AttributesEntry]):
Endpoint configuration attributes that can be used to
control different aspects of the message delivery.
The only currently supported attribute is
``x-goog-version``, which you can use to change the format
of the pushed message. This attribute indicates the version
of the data expected by the endpoint. This controls the
shape of the pushed message (i.e., its fields and metadata).
If not present during the ``CreateSubscription`` call, it
will default to the version of the Pub/Sub API used to make
such call. If not present in a ``ModifyPushConfig`` call,
its value will not be changed. ``GetSubscription`` calls
will always return a valid version, even if the subscription
was created without this attribute.
The only supported values for the ``x-goog-version``
attribute are:
- ``v1beta1``: uses the push format defined in the v1beta1
Pub/Sub API.
- ``v1`` or ``v1beta2``: uses the push format defined in
the v1 Pub/Sub API.
For example:
.. raw:: html
<pre><code>attributes { "x-goog-version": "v1" } </code></pre>
oidc_token (~.pubsub.PushConfig.OidcToken):
If specified, Pub/Sub will generate and attach an OIDC JWT
token as an ``Authorization`` header in the HTTP request for
every pushed message.
"""
class OidcToken(proto.Message):
r"""Contains information needed for generating an `OpenID Connect
token <https://developers.google.com/identity/protocols/OpenIDConnect>`__.
Attributes:
service_account_email (str):
`Service account
email <https://cloud.google.com/iam/docs/service-accounts>`__
to be used for generating the OIDC token. The caller (for
CreateSubscription, UpdateSubscription, and ModifyPushConfig
RPCs) must have the iam.serviceAccounts.actAs permission for
the service account.
audience (str):
Audience to be used when generating OIDC
token. The audience claim identifies the
recipients that the JWT is intended for. The
audience value is a single case-sensitive
string. Having multiple values (array) for the
audience field is not supported. More info about
the OIDC JWT token audience here:
https://tools.ietf.org/html/rfc7519#section-4.1.3
Note: if not specified, the Push endpoint URL
will be used.
"""
service_account_email = proto.Field(proto.STRING, number=1)
audience = proto.Field(proto.STRING, number=2)
push_endpoint = proto.Field(proto.STRING, number=1)
attributes = proto.MapField(proto.STRING, proto.STRING, number=2)
oidc_token = proto.Field(
proto.MESSAGE,
number=3,
message=OidcToken,
)
class FacetSpec(proto.Message):
r"""A facet specification to perform faceted search.
Attributes:
facet_key (google.cloud.retail_v2.types.SearchRequest.FacetSpec.FacetKey):
Required. The facet key specification.
limit (int):
Maximum of facet values that should be returned for this
facet. If unspecified, defaults to 20. The maximum allowed
value is 300. Values above 300 will be coerced to 300.
If this field is negative, an INVALID_ARGUMENT is returned.
excluded_filter_keys (Sequence[str]):
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this
field.
For example, suppose there are 100 products with color facet
"Red" and 200 products with color facet "Blue". A query
containing the filter "colorFamilies:ANY("Red")" and have
"colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
will by default return the "Red" with count 100.
If this field contains "colorFamilies", then the query
returns both the "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from
the filter.
A maximum of 100 values are allowed. Otherwise, an
INVALID_ARGUMENT error is returned.
enable_dynamic_position (bool):
Enables dynamic position for this facet. If set to true, the
position of this facet among all facets in the response is
determined by Google Retail Search. It will be ordered
together with dynamic facets if dynamic facets is enabled.
If set to false, the position of this facet in the response
will be the same as in the request, and it will be ranked
before the facets with dynamic position enable and all
dynamic facets.
For example, you may always want to have rating facet
returned in the response, but it's not necessarily to always
display the rating facet at the top. In that case, you can
set enable_dynamic_position to true so that the position of
rating facet in response will be determined by Google Retail
Search.
Another example, assuming you have the following facets in
the request:
- "rating", enable_dynamic_position = true
- "price", enable_dynamic_position = false
- "brands", enable_dynamic_position = false
And also you have a dynamic facets enable, which will
generate a facet 'gender'. Then the final order of the
facets in the response can be ("price", "brands", "rating",
"gender") or ("price", "brands", "gender", "rating") depends
on how Google Retail Search orders "gender" and "rating"
facets. However, notice that "price" and "brands" will
always be ranked at 1st and 2nd position since their
enable_dynamic_position are false.
"""
class FacetKey(proto.Message):
r"""Specifies how a facet is computed.
Attributes:
key (str):
Required. Supported textual and numerical facet keys in
[Product][google.cloud.retail.v2.Product] object, over which
the facet values are computed. Facet key is case-sensitive.
Allowed facet keys when
[FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
is not specified:
- textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
- numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,attributes.key)".
intervals (Sequence[google.cloud.retail_v2.types.Interval]):
Set only if values should be bucketized into
intervals. Must be set for facets with numerical
values. Must not be set for facet with text
values. Maximum number of intervals is 30.
restricted_values (Sequence[str]):
Only get facet for the given restricted values. For example,
when using "pickupInStore" as key and set restricted values
to ["store123", "store456"], only facets for "store123" and
"store456" are returned. Only supported on textual fields
and fulfillments. Maximum is 20.
Must be set for the fulfillment facet keys:
- pickupInStore
- shipToStore
- sameDayDelivery
- nextDayDelivery
- customFulfillment1
- customFulfillment2
- customFulfillment3
- customFulfillment4
- customFulfillment5
prefixes (Sequence[str]):
Only get facet values that start with the
given string prefix. For example, suppose
"categories" has three values "Women > Shoe",
"Women > Dress" and "Men > Shoe". If set
"prefixes" to "Women", the "categories" facet
will give only "Women > Shoe" and "Women >
Dress". Only supported on textual fields.
Maximum is 10.
contains (Sequence[str]):
Only get facet values that contains the given
strings. For example, suppose "categories" has
three values "Women > Shoe", "Women > Dress" and
"Men > Shoe". If set "contains" to "Shoe", the
"categories" facet will give only "Women > Shoe"
and "Men > Shoe". Only supported on textual
fields. Maximum is 10.
order_by (str):
The order in which [Facet.values][] are returned.
Allowed values are:
- "count desc", which means order by
[Facet.FacetValue.count][] descending.
- "value desc", which means order by
[Facet.FacetValue.value][] descending. Only applies to
textual facets.
If not set, textual values are sorted in `natural
order <https://en.wikipedia.org/wiki/Natural_sort_order>`__;
numerical intervals are sorted in the order given by
[FacetSpec.FacetKey.intervals][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.intervals];
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
are sorted in the order given by
[FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.restricted_values].
query (str):
The query that is used to compute facet for the given facet
key. When provided, it will override the default behavior of
facet computation. The query syntax is the same as a filter
expression. See
[SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]
for detail syntax and limitations. Notice that there is no
limitation on
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
when query is specified.
In the response, [FacetValue.value][] will be always "1" and
[FacetValue.count][] will be the number of results that
matches the query.
For example, you can set a customized facet for
"shipToStore", where
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is "customizedShipToStore", and
[FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
is "availability: ANY("IN_STOCK") AND shipToStore:
ANY("123")". Then the facet will count the products that are
both in stock and ship to store "123".
"""
key = proto.Field(
proto.STRING,
number=1,
)
intervals = proto.RepeatedField(
proto.MESSAGE,
number=2,
message=common.Interval,
)
restricted_values = proto.RepeatedField(
proto.STRING,
number=3,
)
prefixes = proto.RepeatedField(
proto.STRING,
number=8,
)
contains = proto.RepeatedField(
proto.STRING,
number=9,
)
order_by = proto.Field(
proto.STRING,
number=4,
)
query = proto.Field(
proto.STRING,
number=5,
)
facet_key = proto.Field(
proto.MESSAGE,
number=1,
message="SearchRequest.FacetSpec.FacetKey",
)
limit = proto.Field(
proto.INT32,
number=2,
)
excluded_filter_keys = proto.RepeatedField(
proto.STRING,
number=3,
)
enable_dynamic_position = proto.Field(
proto.BOOL,
number=4,
)
class EntityAnnotation(proto.Message):
r"""Set of detected entity features.
Attributes:
mid (str):
Opaque entity ID. Some IDs may be available in `Google
Knowledge Graph Search
API <https://developers.google.com/knowledge-graph/>`__.
locale (str):
The language code for the locale in which the entity textual
``description`` is expressed.
description (str):
Entity textual description, expressed in its ``locale``
language.
score (float):
Overall score of the result. Range [0, 1].
confidence (float):
**Deprecated. Use ``score`` instead.** The accuracy of the
entity detection in an image. For example, for an image in
which the "Eiffel Tower" entity is detected, this field
represents the confidence that there is a tower in the query
image. Range [0, 1].
topicality (float):
The relevancy of the ICA (Image Content Annotation) label to
the image. For example, the relevancy of "tower" is likely
higher to an image containing the detected "Eiffel Tower"
than to an image containing a detected distant towering
building, even though the confidence that there is a tower
in each image may be the same. Range [0, 1].
bounding_poly (~.geometry.BoundingPoly):
Image region to which this entity belongs. Not produced for
``LABEL_DETECTION`` features.
locations (Sequence[~.image_annotator.LocationInfo]):
The location information for the detected entity. Multiple
``LocationInfo`` elements can be present because one
location may indicate the location of the scene in the
image, and another location may indicate the location of the
place where the image was taken. Location information is
usually present for landmarks.
properties (Sequence[~.image_annotator.Property]):
Some entities may have optional user-supplied ``Property``
(name/value) fields, such a score or string that qualifies
the entity.
"""
mid = proto.Field(proto.STRING, number=1)
locale = proto.Field(proto.STRING, number=2)
description = proto.Field(proto.STRING, number=3)
score = proto.Field(proto.FLOAT, number=4)
confidence = proto.Field(proto.FLOAT, number=5)
topicality = proto.Field(proto.FLOAT, number=6)
bounding_poly = proto.Field(
proto.MESSAGE,
number=7,
message=geometry.BoundingPoly,
)
locations = proto.RepeatedField(
proto.MESSAGE,
number=8,
message=LocationInfo,
)
properties = proto.RepeatedField(
proto.MESSAGE,
number=9,
message=Property,
)
class OrganizationSettings(proto.Message):
r"""User specified settings that are attached to the Security
Command Center organization.
Attributes:
name (str):
The relative resource name of the settings. See:
https://cloud.google.com/apis/design/resource_names#relative_resource_name
Example:
"organizations/{organization_id}/organizationSettings".
enable_asset_discovery (bool):
A flag that indicates if Asset Discovery should be enabled.
If the flag is set to ``true``, then discovery of assets
will occur. If it is set to \`false, all historical assets
will remain, but discovery of future assets will not occur.
asset_discovery_config (google.cloud.securitycenter_v1beta1.types.OrganizationSettings.AssetDiscoveryConfig):
The configuration used for Asset Discovery
runs.
"""
class AssetDiscoveryConfig(proto.Message):
r"""The configuration used for Asset Discovery runs.
Attributes:
project_ids (Sequence[str]):
The project ids to use for filtering asset
discovery.
inclusion_mode (google.cloud.securitycenter_v1beta1.types.OrganizationSettings.AssetDiscoveryConfig.InclusionMode):
The mode to use for filtering asset
discovery.
"""
class InclusionMode(proto.Enum):
r"""The mode of inclusion when running Asset Discovery. Asset discovery
can be limited by explicitly identifying projects to be included or
excluded. If INCLUDE_ONLY is set, then only those projects within
the organization and their children are discovered during asset
discovery. If EXCLUDE is set, then projects that don't match those
projects are discovered during asset discovery. If neither are set,
then all projects within the organization are discovered during
asset discovery.
"""
INCLUSION_MODE_UNSPECIFIED = 0
INCLUDE_ONLY = 1
EXCLUDE = 2
project_ids = proto.RepeatedField(
proto.STRING,
number=1,
)
inclusion_mode = proto.Field(
proto.ENUM,
number=2,
enum="OrganizationSettings.AssetDiscoveryConfig.InclusionMode",
)
name = proto.Field(
proto.STRING,
number=1,
)
enable_asset_discovery = proto.Field(
proto.BOOL,
number=2,
)
asset_discovery_config = proto.Field(
proto.MESSAGE,
number=3,
message=AssetDiscoveryConfig,
)
class Foo(proto.Message):
small = proto.Field(proto.INT32, number=1)
big = proto.Field(proto.INT64, number=2)
class Foo(proto.Message):
signed = proto.Field(proto.INT32, number=1)
unsigned = proto.Field(proto.UINT32, number=2)
class Pearl(proto.Message):
mass_kg = proto.Field(proto.INT64, number=1)
class Foo(proto.Message):
spam = proto.Field(proto.INT32, number=1)
eggs = proto.Field(proto.INT32, number=2)
class Shell(proto.Message):
class Pearl(proto.Message):
mass_kg = proto.Field(proto.INT64, number=1)
pearl = proto.Field(Pearl, number=1)
class Squid(proto.Message):
mass_kg = proto.Field(proto.INT64, number=1)
length_cm = proto.Field(proto.UINT64, number=2)
age_s = proto.Field(proto.FIXED64, number=3)
depth_m = proto.Field(proto.SFIXED64, number=4)
serial_num = proto.Field(proto.SINT64, number=5)
class Customer(proto.Message):
r"""A customer.
Attributes:
resource_name (str):
Immutable. The resource name of the customer. Customer
resource names have the form:
``customers/{customer_id}``
id (google.protobuf.wrappers_pb2.Int64Value):
Output only. The ID of the customer.
descriptive_name (google.protobuf.wrappers_pb2.StringValue):
Optional, non-unique descriptive name of the
customer.
currency_code (google.protobuf.wrappers_pb2.StringValue):
Immutable. The currency in which the account
operates. A subset of the currency codes from
the ISO 4217 standard is supported.
time_zone (google.protobuf.wrappers_pb2.StringValue):
Immutable. The local timezone ID of the
customer.
tracking_url_template (google.protobuf.wrappers_pb2.StringValue):
The URL template for constructing a tracking
URL out of parameters.
final_url_suffix (google.protobuf.wrappers_pb2.StringValue):
The URL template for appending params to the
final URL
auto_tagging_enabled (google.protobuf.wrappers_pb2.BoolValue):
Whether auto-tagging is enabled for the
customer.
has_partners_badge (google.protobuf.wrappers_pb2.BoolValue):
Output only. Whether the Customer has a
Partners program badge. If the Customer is not
associated with the Partners program, this will
be false. For more information, see
https://support.google.com/partners/answer/3125774.
manager (google.protobuf.wrappers_pb2.BoolValue):
Output only. Whether the customer is a
manager.
test_account (google.protobuf.wrappers_pb2.BoolValue):
Output only. Whether the customer is a test
account.
call_reporting_setting (google.ads.googleads.v4.resources.types.CallReportingSetting):
Call reporting setting for a customer.
conversion_tracking_setting (google.ads.googleads.v4.resources.types.ConversionTrackingSetting):
Output only. Conversion tracking setting for
a customer.
remarketing_setting (google.ads.googleads.v4.resources.types.RemarketingSetting):
Output only. Remarketing setting for a
customer.
pay_per_conversion_eligibility_failure_reasons (Sequence[google.ads.googleads.v4.enums.types.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason]):
Output only. Reasons why the customer is not
eligible to use PaymentMode.CONVERSIONS. If the
list is empty, the customer is eligible. This
field is read-only.
optimization_score (google.protobuf.wrappers_pb2.DoubleValue):
Output only. Optimization score of the
customer.
Optimization score is an estimate of how well a
customer's campaigns are set to perform. It
ranges from 0% (0.0) to 100% (1.0). This field
is null for all manager customers, and for
unscored non-manager customers.
See "About optimization score" at
https://support.google.com/google-
ads/answer/9061546.
This field is read-only.
"""
resource_name = proto.Field(
proto.STRING,
number=1,
)
id = proto.Field(
proto.MESSAGE,
number=3,
message=wrappers_pb2.Int64Value,
)
descriptive_name = proto.Field(
proto.MESSAGE,
number=4,
message=wrappers_pb2.StringValue,
)
currency_code = proto.Field(
proto.MESSAGE,
number=5,
message=wrappers_pb2.StringValue,
)
time_zone = proto.Field(
proto.MESSAGE,
number=6,
message=wrappers_pb2.StringValue,
)
tracking_url_template = proto.Field(
proto.MESSAGE,
number=7,
message=wrappers_pb2.StringValue,
)
final_url_suffix = proto.Field(
proto.MESSAGE,
number=11,
message=wrappers_pb2.StringValue,
)
auto_tagging_enabled = proto.Field(
proto.MESSAGE,
number=8,
message=wrappers_pb2.BoolValue,
)
has_partners_badge = proto.Field(
proto.MESSAGE,
number=9,
message=wrappers_pb2.BoolValue,
)
manager = proto.Field(
proto.MESSAGE,
number=12,
message=wrappers_pb2.BoolValue,
)
test_account = proto.Field(
proto.MESSAGE,
number=13,
message=wrappers_pb2.BoolValue,
)
call_reporting_setting = proto.Field(
proto.MESSAGE,
number=10,
message='CallReportingSetting',
)
conversion_tracking_setting = proto.Field(
proto.MESSAGE,
number=14,
message='ConversionTrackingSetting',
)
remarketing_setting = proto.Field(
proto.MESSAGE,
number=15,
message='RemarketingSetting',
)
pay_per_conversion_eligibility_failure_reasons = proto.RepeatedField(
proto.ENUM,
number=16,
enum=customer_pay_per_conversion_eligibility_failure_reason.
CustomerPayPerConversionEligibilityFailureReasonEnum.
CustomerPayPerConversionEligibilityFailureReason,
)
optimization_score = proto.Field(
proto.MESSAGE,
number=17,
message=wrappers_pb2.DoubleValue,
)
class FaceAnnotation(proto.Message):
r"""A face annotation object contains the results of face
detection.
Attributes:
bounding_poly (~.geometry.BoundingPoly):
The bounding polygon around the face. The coordinates of the
bounding box are in the original image's scale. The bounding
box is computed to "frame" the face in accordance with human
expectations. It is based on the landmarker results. Note
that one or more x and/or y coordinates may not be generated
in the ``BoundingPoly`` (the polygon will be unbounded) if
only a partial face appears in the image to be annotated.
fd_bounding_poly (~.geometry.BoundingPoly):
The ``fd_bounding_poly`` bounding polygon is tighter than
the ``boundingPoly``, and encloses only the skin part of the
face. Typically, it is used to eliminate the face from any
image analysis that detects the "amount of skin" visible in
an image. It is not based on the landmarker results, only on
the initial face detection, hence the fd (face detection)
prefix.
landmarks (Sequence[~.image_annotator.FaceAnnotation.Landmark]):
Detected face landmarks.
roll_angle (float):
Roll angle, which indicates the amount of
clockwise/anti-clockwise rotation of the face relative to
the image vertical about the axis perpendicular to the face.
Range [-180,180].
pan_angle (float):
Yaw angle, which indicates the leftward/rightward angle that
the face is pointing relative to the vertical plane
perpendicular to the image. Range [-180,180].
tilt_angle (float):
Pitch angle, which indicates the upwards/downwards angle
that the face is pointing relative to the image's horizontal
plane. Range [-180,180].
detection_confidence (float):
Detection confidence. Range [0, 1].
landmarking_confidence (float):
Face landmarking confidence. Range [0, 1].
joy_likelihood (~.image_annotator.Likelihood):
Joy likelihood.
sorrow_likelihood (~.image_annotator.Likelihood):
Sorrow likelihood.
anger_likelihood (~.image_annotator.Likelihood):
Anger likelihood.
surprise_likelihood (~.image_annotator.Likelihood):
Surprise likelihood.
under_exposed_likelihood (~.image_annotator.Likelihood):
Under-exposed likelihood.
blurred_likelihood (~.image_annotator.Likelihood):
Blurred likelihood.
headwear_likelihood (~.image_annotator.Likelihood):
Headwear likelihood.
recognition_result (Sequence[~.face.FaceRecognitionResult]):
Additional recognition information. Only computed if
image_context.face_recognition_params is provided, **and** a
match is found to a
[Celebrity][google.cloud.vision.v1p4beta1.Celebrity] in the
input
[CelebritySet][google.cloud.vision.v1p4beta1.CelebritySet].
This field is sorted in order of decreasing confidence
values.
"""
class Landmark(proto.Message):
r"""A face-specific landmark (for example, a face feature).
Attributes:
type_ (~.image_annotator.FaceAnnotation.Landmark.Type):
Face landmark type.
position (~.geometry.Position):
Face landmark position.
"""
class Type(proto.Enum):
r"""Face landmark (feature) type. Left and right are defined from the
vantage of the viewer of the image without considering mirror
projections typical of photos. So, ``LEFT_EYE``, typically, is the
person's right eye.
"""
UNKNOWN_LANDMARK = 0
LEFT_EYE = 1
RIGHT_EYE = 2
LEFT_OF_LEFT_EYEBROW = 3
RIGHT_OF_LEFT_EYEBROW = 4
LEFT_OF_RIGHT_EYEBROW = 5
RIGHT_OF_RIGHT_EYEBROW = 6
MIDPOINT_BETWEEN_EYES = 7
NOSE_TIP = 8
UPPER_LIP = 9
LOWER_LIP = 10
MOUTH_LEFT = 11
MOUTH_RIGHT = 12
MOUTH_CENTER = 13
NOSE_BOTTOM_RIGHT = 14
NOSE_BOTTOM_LEFT = 15
NOSE_BOTTOM_CENTER = 16
LEFT_EYE_TOP_BOUNDARY = 17
LEFT_EYE_RIGHT_CORNER = 18
LEFT_EYE_BOTTOM_BOUNDARY = 19
LEFT_EYE_LEFT_CORNER = 20
RIGHT_EYE_TOP_BOUNDARY = 21
RIGHT_EYE_RIGHT_CORNER = 22
RIGHT_EYE_BOTTOM_BOUNDARY = 23
RIGHT_EYE_LEFT_CORNER = 24
LEFT_EYEBROW_UPPER_MIDPOINT = 25
RIGHT_EYEBROW_UPPER_MIDPOINT = 26
LEFT_EAR_TRAGION = 27
RIGHT_EAR_TRAGION = 28
LEFT_EYE_PUPIL = 29
RIGHT_EYE_PUPIL = 30
FOREHEAD_GLABELLA = 31
CHIN_GNATHION = 32
CHIN_LEFT_GONION = 33
CHIN_RIGHT_GONION = 34
type_ = proto.Field(
proto.ENUM,
number=3,
enum="FaceAnnotation.Landmark.Type",
)
position = proto.Field(
proto.MESSAGE,
number=4,
message=geometry.Position,
)
bounding_poly = proto.Field(
proto.MESSAGE,
number=1,
message=geometry.BoundingPoly,
)
fd_bounding_poly = proto.Field(
proto.MESSAGE,
number=2,
message=geometry.BoundingPoly,
)
landmarks = proto.RepeatedField(
proto.MESSAGE,
number=3,
message=Landmark,
)
roll_angle = proto.Field(proto.FLOAT, number=4)
pan_angle = proto.Field(proto.FLOAT, number=5)
tilt_angle = proto.Field(proto.FLOAT, number=6)
detection_confidence = proto.Field(proto.FLOAT, number=7)
landmarking_confidence = proto.Field(proto.FLOAT, number=8)
joy_likelihood = proto.Field(
proto.ENUM,
number=9,
enum="Likelihood",
)
sorrow_likelihood = proto.Field(
proto.ENUM,
number=10,
enum="Likelihood",
)
anger_likelihood = proto.Field(
proto.ENUM,
number=11,
enum="Likelihood",
)
surprise_likelihood = proto.Field(
proto.ENUM,
number=12,
enum="Likelihood",
)
under_exposed_likelihood = proto.Field(
proto.ENUM,
number=13,
enum="Likelihood",
)
blurred_likelihood = proto.Field(
proto.ENUM,
number=14,
enum="Likelihood",
)
headwear_likelihood = proto.Field(
proto.ENUM,
number=15,
enum="Likelihood",
)
recognition_result = proto.RepeatedField(
proto.MESSAGE,
number=16,
message=face.FaceRecognitionResult,
)
class Foo(proto.Message):
bar = proto.Field(proto.INT32, number=1)
class Landmark(proto.Message):
r"""A face-specific landmark (for example, a face feature).
Attributes:
type_ (~.image_annotator.FaceAnnotation.Landmark.Type):
Face landmark type.
position (~.geometry.Position):
Face landmark position.
"""
class Type(proto.Enum):
r"""Face landmark (feature) type. Left and right are defined from the
vantage of the viewer of the image without considering mirror
projections typical of photos. So, ``LEFT_EYE``, typically, is the
person's right eye.
"""
UNKNOWN_LANDMARK = 0
LEFT_EYE = 1
RIGHT_EYE = 2
LEFT_OF_LEFT_EYEBROW = 3
RIGHT_OF_LEFT_EYEBROW = 4
LEFT_OF_RIGHT_EYEBROW = 5
RIGHT_OF_RIGHT_EYEBROW = 6
MIDPOINT_BETWEEN_EYES = 7
NOSE_TIP = 8
UPPER_LIP = 9
LOWER_LIP = 10
MOUTH_LEFT = 11
MOUTH_RIGHT = 12
MOUTH_CENTER = 13
NOSE_BOTTOM_RIGHT = 14
NOSE_BOTTOM_LEFT = 15
NOSE_BOTTOM_CENTER = 16
LEFT_EYE_TOP_BOUNDARY = 17
LEFT_EYE_RIGHT_CORNER = 18
LEFT_EYE_BOTTOM_BOUNDARY = 19
LEFT_EYE_LEFT_CORNER = 20
RIGHT_EYE_TOP_BOUNDARY = 21
RIGHT_EYE_RIGHT_CORNER = 22
RIGHT_EYE_BOTTOM_BOUNDARY = 23
RIGHT_EYE_LEFT_CORNER = 24
LEFT_EYEBROW_UPPER_MIDPOINT = 25
RIGHT_EYEBROW_UPPER_MIDPOINT = 26
LEFT_EAR_TRAGION = 27
RIGHT_EAR_TRAGION = 28
LEFT_EYE_PUPIL = 29
RIGHT_EYE_PUPIL = 30
FOREHEAD_GLABELLA = 31
CHIN_GNATHION = 32
CHIN_LEFT_GONION = 33
CHIN_RIGHT_GONION = 34
type_ = proto.Field(
proto.ENUM,
number=3,
enum="FaceAnnotation.Landmark.Type",
)
position = proto.Field(
proto.MESSAGE,
number=4,
message=geometry.Position,
)
class CampaignBudget(proto.Message):
r"""A campaign budget.
Attributes:
resource_name (str):
Immutable. The resource name of the campaign budget.
Campaign budget resource names have the form:
``customers/{customer_id}/campaignBudgets/{campaign_budget_id}``
id (int):
Output only. The ID of the campaign budget.
A campaign budget is created using the
CampaignBudgetService create operation and is
assigned a budget ID. A budget ID can be shared
across different campaigns; the system will then
allocate the campaign budget among different
campaigns to get optimum results.
name (str):
The name of the campaign budget.
When creating a campaign budget through
CampaignBudgetService, every explicitly shared
campaign budget must have a non-null, non-empty
name. Campaign budgets that are not explicitly
shared derive their name from the attached
campaign's name.
The length of this string must be between 1 and
255, inclusive, in UTF-8 bytes, (trimmed).
amount_micros (int):
The amount of the budget, in the local
currency for the account. Amount is specified in
micros, where one million is equivalent to one
currency unit. Monthly spend is capped at 30.4
times this amount.
total_amount_micros (int):
The lifetime amount of the budget, in the
local currency for the account. Amount is
specified in micros, where one million is
equivalent to one currency unit.
status (google.ads.googleads.v5.enums.types.BudgetStatusEnum.BudgetStatus):
Output only. The status of this campaign
budget. This field is read-only.
delivery_method (google.ads.googleads.v5.enums.types.BudgetDeliveryMethodEnum.BudgetDeliveryMethod):
The delivery method that determines the rate
at which the campaign budget is spent.
Defaults to STANDARD if unspecified in a create
operation.
explicitly_shared (bool):
Specifies whether the budget is explicitly
shared. Defaults to true if unspecified in a
create operation.
If true, the budget was created with the purpose
of sharing across one or more campaigns.
If false, the budget was created with the
intention of only being used with a single
campaign. The budget's name and status will stay
in sync with the campaign's name and status.
Attempting to share the budget with a second
campaign will result in an error.
A non-shared budget can become an explicitly
shared. The same operation must also assign the
budget a name.
A shared campaign budget can never become non-
shared.
reference_count (int):
Output only. The number of campaigns actively
using the budget.
This field is read-only.
has_recommended_budget (bool):
Output only. Indicates whether there is a
recommended budget for this campaign budget.
This field is read-only.
recommended_budget_amount_micros (int):
Output only. The recommended budget amount.
If no recommendation is available, this will be
set to the budget amount. Amount is specified in
micros, where one million is equivalent to one
currency unit.
This field is read-only.
period (google.ads.googleads.v5.enums.types.BudgetPeriodEnum.BudgetPeriod):
Immutable. Period over which to spend the
budget. Defaults to DAILY if not specified.
recommended_budget_estimated_change_weekly_clicks (int):
Output only. The estimated change in weekly
clicks if the recommended budget is applied.
This field is read-only.
recommended_budget_estimated_change_weekly_cost_micros (int):
Output only. The estimated change in weekly
cost in micros if the recommended budget is
applied. One million is equivalent to one
currency unit.
This field is read-only.
recommended_budget_estimated_change_weekly_interactions (int):
Output only. The estimated change in weekly
interactions if the recommended budget is
applied.
This field is read-only.
recommended_budget_estimated_change_weekly_views (int):
Output only. The estimated change in weekly
views if the recommended budget is applied.
This field is read-only.
type_ (google.ads.googleads.v5.enums.types.BudgetTypeEnum.BudgetType):
Immutable. The type of the campaign budget.
"""
resource_name = proto.Field(proto.STRING, number=1)
id = proto.Field(proto.INT64, number=19, optional=True)
name = proto.Field(proto.STRING, number=20, optional=True)
amount_micros = proto.Field(proto.INT64, number=21, optional=True)
total_amount_micros = proto.Field(proto.INT64, number=22, optional=True)
status = proto.Field(
proto.ENUM, number=6, enum=budget_status.BudgetStatusEnum.BudgetStatus,
)
delivery_method = proto.Field(
proto.ENUM,
number=7,
enum=budget_delivery_method.BudgetDeliveryMethodEnum.BudgetDeliveryMethod,
)
explicitly_shared = proto.Field(proto.BOOL, number=23, optional=True)
reference_count = proto.Field(proto.INT64, number=24, optional=True)
has_recommended_budget = proto.Field(proto.BOOL, number=25, optional=True)
recommended_budget_amount_micros = proto.Field(
proto.INT64, number=26, optional=True
)
period = proto.Field(
proto.ENUM, number=13, enum=budget_period.BudgetPeriodEnum.BudgetPeriod,
)
recommended_budget_estimated_change_weekly_clicks = proto.Field(
proto.INT64, number=27, optional=True
)
recommended_budget_estimated_change_weekly_cost_micros = proto.Field(
proto.INT64, number=28, optional=True
)
recommended_budget_estimated_change_weekly_interactions = proto.Field(
proto.INT64, number=29, optional=True
)
recommended_budget_estimated_change_weekly_views = proto.Field(
proto.INT64, number=30, optional=True
)
type_ = proto.Field(
proto.ENUM, number=18, enum=budget_type.BudgetTypeEnum.BudgetType,
)
class AnnotateImageResponse(proto.Message):
r"""Response to an image annotation request.
Attributes:
face_annotations (Sequence[~.image_annotator.FaceAnnotation]):
If present, face detection has completed
successfully.
landmark_annotations (Sequence[~.image_annotator.EntityAnnotation]):
If present, landmark detection has completed
successfully.
logo_annotations (Sequence[~.image_annotator.EntityAnnotation]):
If present, logo detection has completed
successfully.
label_annotations (Sequence[~.image_annotator.EntityAnnotation]):
If present, label detection has completed
successfully.
localized_object_annotations (Sequence[~.image_annotator.LocalizedObjectAnnotation]):
If present, localized object detection has
completed successfully. This will be sorted
descending by confidence score.
text_annotations (Sequence[~.image_annotator.EntityAnnotation]):
If present, text (OCR) detection has
completed successfully.
full_text_annotation (~.text_annotation.TextAnnotation):
If present, text (OCR) detection or document
(OCR) text detection has completed successfully.
This annotation provides the structural
hierarchy for the OCR detected text.
safe_search_annotation (~.image_annotator.SafeSearchAnnotation):
If present, safe-search annotation has
completed successfully.
image_properties_annotation (~.image_annotator.ImageProperties):
If present, image properties were extracted
successfully.
crop_hints_annotation (~.image_annotator.CropHintsAnnotation):
If present, crop hints have completed
successfully.
web_detection (~.gcv_web_detection.WebDetection):
If present, web detection has completed
successfully.
product_search_results (~.product_search.ProductSearchResults):
If present, product search has completed
successfully.
error (~.status.Status):
If set, represents the error message for the operation. Note
that filled-in image annotations are guaranteed to be
correct, even when ``error`` is set.
context (~.image_annotator.ImageAnnotationContext):
If present, contextual information is needed
to understand where this image comes from.
"""
face_annotations = proto.RepeatedField(
proto.MESSAGE,
number=1,
message=FaceAnnotation,
)
landmark_annotations = proto.RepeatedField(
proto.MESSAGE,
number=2,
message=EntityAnnotation,
)
logo_annotations = proto.RepeatedField(
proto.MESSAGE,
number=3,
message=EntityAnnotation,
)
label_annotations = proto.RepeatedField(
proto.MESSAGE,
number=4,
message=EntityAnnotation,
)
localized_object_annotations = proto.RepeatedField(
proto.MESSAGE,
number=22,
message=LocalizedObjectAnnotation,
)
text_annotations = proto.RepeatedField(
proto.MESSAGE,
number=5,
message=EntityAnnotation,
)
full_text_annotation = proto.Field(
proto.MESSAGE,
number=12,
message=text_annotation.TextAnnotation,
)
safe_search_annotation = proto.Field(
proto.MESSAGE,
number=6,
message=SafeSearchAnnotation,
)
image_properties_annotation = proto.Field(
proto.MESSAGE,
number=8,
message=ImageProperties,
)
crop_hints_annotation = proto.Field(
proto.MESSAGE,
number=11,
message=CropHintsAnnotation,
)
web_detection = proto.Field(
proto.MESSAGE,
number=13,
message=gcv_web_detection.WebDetection,
)
product_search_results = proto.Field(
proto.MESSAGE,
number=14,
message=product_search.ProductSearchResults,
)
error = proto.Field(
proto.MESSAGE,
number=9,
message=status.Status,
)
context = proto.Field(
proto.MESSAGE,
number=21,
message=ImageAnnotationContext,
)
class Finding(proto.Message):
r"""Security Command Center finding.
A finding is a record of assessment data (security, risk, health
or privacy) ingested into Security Command Center for
presentation, notification, analysis, policy testing, and
enforcement. For example, an XSS vulnerability in an App Engine
application is a finding.
Attributes:
name (str):
The relative resource name of this finding. See:
https://cloud.google.com/apis/design/resource_names#relative_resource_name
Example:
"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}".
parent (str):
The relative resource name of the source the finding belongs
to. See:
https://cloud.google.com/apis/design/resource_names#relative_resource_name
This field is immutable after creation time. For example:
"organizations/{organization_id}/sources/{source_id}".
resource_name (str):
For findings on Google Cloud resources, the full resource
name of the Google Cloud resource this finding is for. See:
https://cloud.google.com/apis/design/resource_names#full_resource_name
When the finding is for a non-Google Cloud resource, the
resourceName can be a customer or partner defined string.
This field is immutable after creation time.
state (google.cloud.securitycenter_v1p1beta1.types.Finding.State):
The state of the finding.
category (str):
The additional taxonomy group within findings from a given
source. This field is immutable after creation time.
Example: "XSS_FLASH_INJECTION".
external_uri (str):
The URI that, if available, points to a web
page outside of Security Command Center where
additional information about the finding can be
found. This field is guaranteed to be either
empty or a well formed URL.
source_properties (Sequence[google.cloud.securitycenter_v1p1beta1.types.Finding.SourcePropertiesEntry]):
Source specific properties. These properties are managed by
the source that writes the finding. The key names in the
source_properties map must be between 1 and 255 characters,
and must start with a letter and contain alphanumeric
characters or underscores only.
security_marks (google.cloud.securitycenter_v1p1beta1.types.SecurityMarks):
Output only. User specified security marks.
These marks are entirely managed by the user and
come from the SecurityMarks resource that
belongs to the finding.
event_time (google.protobuf.timestamp_pb2.Timestamp):
The time at which the event took place, or
when an update to the finding occurred. For
example, if the finding represents an open
firewall it would capture the time the detector
believes the firewall became open. The accuracy
is determined by the detector. If the finding
were to be resolved afterward, this time would
reflect when the finding was resolved. Must not
be set to a value greater than the current
timestamp.
create_time (google.protobuf.timestamp_pb2.Timestamp):
The time at which the finding was created in
Security Command Center.
severity (google.cloud.securitycenter_v1p1beta1.types.Finding.Severity):
The severity of the finding. This field is
managed by the source that writes the finding.
canonical_name (str):
The canonical name of the finding. It's either
"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}",
"folders/{folder_id}/sources/{source_id}/findings/{finding_id}"
or
"projects/{project_number}/sources/{source_id}/findings/{finding_id}",
depending on the closest CRM ancestor of the resource
associated with the finding.
"""
class State(proto.Enum):
r"""The state of the finding."""
STATE_UNSPECIFIED = 0
ACTIVE = 1
INACTIVE = 2
class Severity(proto.Enum):
r"""The severity of the finding. This field is managed by the
source that writes the finding.
"""
SEVERITY_UNSPECIFIED = 0
CRITICAL = 1
HIGH = 2
MEDIUM = 3
LOW = 4
name = proto.Field(
proto.STRING,
number=1,
)
parent = proto.Field(
proto.STRING,
number=2,
)
resource_name = proto.Field(
proto.STRING,
number=3,
)
state = proto.Field(
proto.ENUM,
number=4,
enum=State,
)
category = proto.Field(
proto.STRING,
number=5,
)
external_uri = proto.Field(
proto.STRING,
number=6,
)
source_properties = proto.MapField(
proto.STRING,
proto.MESSAGE,
number=7,
message=struct_pb2.Value,
)
security_marks = proto.Field(
proto.MESSAGE,
number=8,
message=gcs_security_marks.SecurityMarks,
)
event_time = proto.Field(
proto.MESSAGE,
number=9,
message=timestamp_pb2.Timestamp,
)
create_time = proto.Field(
proto.MESSAGE,
number=10,
message=timestamp_pb2.Timestamp,
)
severity = proto.Field(
proto.ENUM,
number=13,
enum=Severity,
)
canonical_name = proto.Field(
proto.STRING,
number=14,
)
class Subscription(proto.Message):
r"""A subscription resource.
Attributes:
name (str):
Required. The name of the subscription. It must have the
format
``"projects/{project}/subscriptions/{subscription}"``.
``{subscription}`` must start with a letter, and contain
only letters (``[A-Za-z]``), numbers (``[0-9]``), dashes
(``-``), underscores (``_``), periods (``.``), tildes
(``~``), plus (``+``) or percent signs (``%``). It must be
between 3 and 255 characters in length, and it must not
start with ``"goog"``.
topic (str):
Required. The name of the topic from which this subscription
is receiving messages. Format is
``projects/{project}/topics/{topic}``. The value of this
field will be ``_deleted-topic_`` if the topic has been
deleted.
push_config (~.pubsub.PushConfig):
If push delivery is used with this subscription, this field
is used to configure it. An empty ``pushConfig`` signifies
that the subscriber will pull and ack messages using API
methods.
ack_deadline_seconds (int):
The approximate amount of time (on a best-effort basis)
Pub/Sub waits for the subscriber to acknowledge receipt
before resending the message. In the interval after the
message is delivered and before it is acknowledged, it is
considered to be outstanding. During that time period, the
message will not be redelivered (on a best-effort basis).
For pull subscriptions, this value is used as the initial
value for the ack deadline. To override this value for a
given message, call ``ModifyAckDeadline`` with the
corresponding ``ack_id`` if using non-streaming pull or send
the ``ack_id`` in a ``StreamingModifyAckDeadlineRequest`` if
using streaming pull. The minimum custom deadline you can
specify is 10 seconds. The maximum custom deadline you can
specify is 600 seconds (10 minutes). If this parameter is 0,
a default value of 10 seconds is used.
For push delivery, this value is also used to set the
request timeout for the call to the push endpoint.
If the subscriber never acknowledges the message, the
Pub/Sub system will eventually redeliver the message.
retain_acked_messages (bool):
Indicates whether to retain acknowledged messages. If true,
then messages are not expunged from the subscription's
backlog, even if they are acknowledged, until they fall out
of the ``message_retention_duration`` window. This must be
true if you would like to Seek to a timestamp.
message_retention_duration (~.duration.Duration):
How long to retain unacknowledged messages in the
subscription's backlog, from the moment a message is
published. If ``retain_acked_messages`` is true, then this
also configures the retention of acknowledged messages, and
thus configures how far back in time a ``Seek`` can be done.
Defaults to 7 days. Cannot be more than 7 days or less than
10 minutes.
labels (Sequence[~.pubsub.Subscription.LabelsEntry]):
See <a
href="https://cloud.google.com/pubsub/docs/labels">
Creating and managing labels</a>.
enable_message_ordering (bool):
If true, messages published with the same ``ordering_key``
in ``PubsubMessage`` will be delivered to the subscribers in
the order in which they are received by the Pub/Sub system.
Otherwise, they may be delivered in any order. EXPERIMENTAL:
This feature is part of a closed alpha release. This API
might be changed in backward-incompatible ways and is not
recommended for production use. It is not subject to any SLA
or deprecation policy.
expiration_policy (~.pubsub.ExpirationPolicy):
A policy that specifies the conditions for this
subscription's expiration. A subscription is considered
active as long as any connected subscriber is successfully
consuming messages from the subscription or is issuing
operations on the subscription. If ``expiration_policy`` is
not set, a *default policy* with ``ttl`` of 31 days will be
used. The minimum allowed value for
``expiration_policy.ttl`` is 1 day.
filter (str):
An expression written in the Cloud Pub/Sub filter language.
If non-empty, then only ``PubsubMessage``\ s whose
``attributes`` field matches the filter are delivered on
this subscription. If empty, then no messages are filtered
out. EXPERIMENTAL: This feature is part of a closed alpha
release. This API might be changed in backward-incompatible
ways and is not recommended for production use. It is not
subject to any SLA or deprecation policy.
dead_letter_policy (~.pubsub.DeadLetterPolicy):
A policy that specifies the conditions for dead lettering
messages in this subscription. If dead\_letter\_policy is
not set, dead lettering is disabled.
The Cloud Pub/Sub service account associated with this
subscriptions's parent project (i.e.,
service-{project\_number}@gcp-sa-pubsub.iam.gserviceaccount.com)
must have permission to Acknowledge() messages on this
subscription. EXPERIMENTAL: This feature is part of a closed
alpha release. This API might be changed in
backward-incompatible ways and is not recommended for
production use. It is not subject to any SLA or deprecation
policy.
retry_policy (~.pubsub.RetryPolicy):
A policy that specifies how Cloud Pub/Sub
retries message delivery for this subscription.
If not set, the default retry policy is applied.
This generally implies that messages will be
retried as soon as possible for healthy
subscribers. RetryPolicy will be triggered on
NACKs or acknowledgement deadline exceeded
events for a given message.
<b>EXPERIMENTAL:</b> This API might be changed
in backward-incompatible ways and is not
recommended for production use. It is not
subject to any SLA or deprecation policy.
"""
name = proto.Field(proto.STRING, number=1)
topic = proto.Field(proto.STRING, number=2)
push_config = proto.Field(
proto.MESSAGE,
number=4,
message='PushConfig',
)
ack_deadline_seconds = proto.Field(proto.INT32, number=5)
retain_acked_messages = proto.Field(proto.BOOL, number=7)
message_retention_duration = proto.Field(
proto.MESSAGE,
number=8,
message=duration.Duration,
)
labels = proto.MapField(proto.STRING, proto.STRING, number=9)
enable_message_ordering = proto.Field(proto.BOOL, number=10)
expiration_policy = proto.Field(
proto.MESSAGE,
number=11,
message='ExpirationPolicy',
)
filter = proto.Field(proto.STRING, number=12)
dead_letter_policy = proto.Field(
proto.MESSAGE,
number=13,
message='DeadLetterPolicy',
)
retry_policy = proto.Field(
proto.MESSAGE,
number=14,
message='RetryPolicy',
)
class Tensorboard(proto.Message):
r"""Tensorboard is a physical database that stores users'
training metrics. A default Tensorboard is provided in each
region of a GCP project. If needed users can also create extra
Tensorboards in their projects.
Attributes:
name (str):
Output only. Name of the Tensorboard. Format:
``projects/{project}/locations/{location}/tensorboards/{tensorboard}``
display_name (str):
Required. User provided name of this
Tensorboard.
description (str):
Description of this Tensorboard.
encryption_spec (google.cloud.aiplatform_v1beta1.types.EncryptionSpec):
Customer-managed encryption key spec for a
Tensorboard. If set, this Tensorboard and all
sub-resources of this Tensorboard will be
secured by this key.
blob_storage_path_prefix (str):
Output only. Consumer project Cloud Storage
path prefix used to store blob data, which can
either be a bucket or directory. Does not end
with a '/'.
run_count (int):
Output only. The number of Runs stored in
this Tensorboard.
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Timestamp when this Tensorboard
was created.
update_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Timestamp when this Tensorboard
was last updated.
labels (Sequence[google.cloud.aiplatform_v1beta1.types.Tensorboard.LabelsEntry]):
The labels with user-defined metadata to
organize your Tensorboards.
Label keys and values can be no longer than 64
characters (Unicode codepoints), can only
contain lowercase letters, numeric characters,
underscores and dashes. International characters
are allowed. No more than 64 user labels can be
associated with one Tensorboard (System labels
are excluded).
See https://goo.gl/xmQnxf for more information
and examples of labels. System reserved label
keys are prefixed with
"aiplatform.googleapis.com/" and are immutable.
etag (str):
Used to perform a consistent
read-modify-write updates. If not set, a blind
"overwrite" update happens.
"""
name = proto.Field(
proto.STRING,
number=1,
)
display_name = proto.Field(
proto.STRING,
number=2,
)
description = proto.Field(
proto.STRING,
number=3,
)
encryption_spec = proto.Field(
proto.MESSAGE,
number=11,
message=gca_encryption_spec.EncryptionSpec,
)
blob_storage_path_prefix = proto.Field(
proto.STRING,
number=10,
)
run_count = proto.Field(
proto.INT32,
number=5,
)
create_time = proto.Field(
proto.MESSAGE,
number=6,
message=timestamp_pb2.Timestamp,
)
update_time = proto.Field(
proto.MESSAGE,
number=7,
message=timestamp_pb2.Timestamp,
)
labels = proto.MapField(
proto.STRING,
proto.STRING,
number=8,
)
etag = proto.Field(
proto.STRING,
number=9,
)
class StreamingPullRequest(proto.Message):
r"""Request for the ``StreamingPull`` streaming RPC method. This request
is used to establish the initial stream as well as to stream
acknowledgements and ack deadline modifications from the client to
the server.
Attributes:
subscription (str):
Required. The subscription for which to initialize the new
stream. This must be provided in the first request on the
stream, and must not be set in subsequent requests from
client to server. Format is
``projects/{project}/subscriptions/{sub}``.
ack_ids (Sequence[str]):
List of acknowledgement IDs for acknowledging previously
received messages (received on this stream or a different
stream). If an ack ID has expired, the corresponding message
may be redelivered later. Acknowledging a message more than
once will not result in an error. If the acknowledgement ID
is malformed, the stream will be aborted with status
``INVALID_ARGUMENT``.
modify_deadline_seconds (Sequence[int]):
The list of new ack deadlines for the IDs listed in
``modify_deadline_ack_ids``. The size of this list must be
the same as the size of ``modify_deadline_ack_ids``. If it
differs the stream will be aborted with
``INVALID_ARGUMENT``. Each element in this list is applied
to the element in the same position in
``modify_deadline_ack_ids``. The new ack deadline is with
respect to the time this request was sent to the Pub/Sub
system. Must be >= 0. For example, if the value is 10, the
new ack deadline will expire 10 seconds after this request
is received. If the value is 0, the message is immediately
made available for another streaming or non-streaming pull
request. If the value is < 0 (an error), the stream will be
aborted with status ``INVALID_ARGUMENT``.
modify_deadline_ack_ids (Sequence[str]):
List of acknowledgement IDs whose deadline will be modified
based on the corresponding element in
``modify_deadline_seconds``. This field can be used to
indicate that more time is needed to process a message by
the subscriber, or to make the message available for
redelivery if the processing was interrupted.
stream_ack_deadline_seconds (int):
Required. The ack deadline to use for the
stream. This must be provided in the first
request on the stream, but it can also be
updated on subsequent requests from client to
server. The minimum deadline you can specify is
10 seconds. The maximum deadline you can specify
is 600 seconds (10 minutes).
client_id (str):
A unique identifier that is used to distinguish client
instances from each other. Only needs to be provided on the
initial request. When a stream disconnects and reconnects
for the same stream, the client\_id should be set to the
same value so that state associated with the old stream can
be transferred to the new stream. The same client\_id should
not be used for different client instances.
"""
subscription = proto.Field(proto.STRING, number=1)
ack_ids = proto.RepeatedField(proto.STRING, number=2)
modify_deadline_seconds = proto.RepeatedField(proto.INT32, number=3)
modify_deadline_ack_ids = proto.RepeatedField(proto.STRING, number=4)
stream_ack_deadline_seconds = proto.Field(proto.INT32, number=5)
client_id = proto.Field(proto.STRING, number=6)
class CompleteQueryRequest(proto.Message):
r"""Auto-complete parameters.
Attributes:
tenant (str):
Required. Resource name of tenant the completion is
performed within.
The format is "projects/{project_id}/tenants/{tenant_id}",
for example, "projects/foo/tenants/bar".
query (str):
Required. The query used to generate
suggestions.
The maximum number of allowed characters is 255.
language_codes (Sequence[str]):
The list of languages of the query. This is the BCP-47
language code, such as "en-US" or "sr-Latn". For more
information, see `Tags for Identifying
Languages <https://tools.ietf.org/html/bcp47>`__.
The maximum number of allowed characters is 255.
page_size (int):
Required. Completion result count.
The maximum allowed page size is 10.
company (str):
If provided, restricts completion to specified company.
The format is
"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}",
for example, "projects/foo/tenants/bar/companies/baz".
scope (~.completion_service.CompleteQueryRequest.CompletionScope):
The scope of the completion. The defaults is
[CompletionScope.PUBLIC][google.cloud.talent.v4.CompleteQueryRequest.CompletionScope.PUBLIC].
type_ (~.completion_service.CompleteQueryRequest.CompletionType):
The completion topic. The default is
[CompletionType.COMBINED][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMBINED].
"""
class CompletionScope(proto.Enum):
r"""Enum to specify the scope of completion."""
COMPLETION_SCOPE_UNSPECIFIED = 0
TENANT = 1
PUBLIC = 2
class CompletionType(proto.Enum):
r"""Enum to specify auto-completion topics."""
COMPLETION_TYPE_UNSPECIFIED = 0
JOB_TITLE = 1
COMPANY_NAME = 2
COMBINED = 3
tenant = proto.Field(proto.STRING, number=1)
query = proto.Field(proto.STRING, number=2)
language_codes = proto.RepeatedField(proto.STRING, number=3)
page_size = proto.Field(proto.INT32, number=4)
company = proto.Field(proto.STRING, number=5)
scope = proto.Field(
proto.ENUM,
number=6,
enum=CompletionScope,
)
type_ = proto.Field(
proto.ENUM,
number=7,
enum=CompletionType,
)
class SearchRequest(proto.Message):
r"""Request message for
[SearchService.Search][google.cloud.retail.v2.SearchService.Search]
method.
Attributes:
placement (str):
Required. The resource name of the search engine placement,
such as
``projects/*/locations/global/catalogs/default_catalog/placements/default_search``.
This field is used to identify the serving configuration
name and the set of models that will be used to make the
search.
branch (str):
The branch resource name, such as
``projects/*/locations/global/catalogs/default_catalog/branches/0``.
Use "default_branch" as the branch ID or leave this field
empty, to search products under the default branch.
query (str):
Raw search query.
visitor_id (str):
Required. A unique identifier for tracking visitors. For
example, this could be implemented with an HTTP cookie,
which should be able to uniquely identify a visitor on a
single device. This unique identifier should not change if
the visitor logs in or out of the website.
The field must be a UTF-8 encoded string with a length limit
of 128 characters. Otherwise, an INVALID_ARGUMENT error is
returned.
user_info (google.cloud.retail_v2.types.UserInfo):
User information.
page_size (int):
Maximum number of [Product][google.cloud.retail.v2.Product]s
to return. If unspecified, defaults to a reasonable value.
The maximum allowed value is 120. Values above 120 will be
coerced to 120.
If this field is negative, an INVALID_ARGUMENT is returned.
page_token (str):
A page token
[SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token],
received from a previous
[SearchService.Search][google.cloud.retail.v2.SearchService.Search]
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
[SearchService.Search][google.cloud.retail.v2.SearchService.Search]
must match the call that provided the page token. Otherwise,
an INVALID_ARGUMENT error is returned.
offset (int):
A 0-indexed integer that specifies the current offset (that
is, starting result location, amongst the
[Product][google.cloud.retail.v2.Product]s deemed by the API
as relevant) in search results. This field is only
considered if
[page_token][google.cloud.retail.v2.SearchRequest.page_token]
is unset.
If this field is negative, an INVALID_ARGUMENT is returned.
filter (str):
The filter syntax consists of an expression language for
constructing a predicate from one or more fields of the
products being filtered. Filter expression is
case-sensitive. See more details at this `user
guide <https://cloud.google.com/retail/docs/filter-and-order#filter>`__.
If this field is unrecognizable, an INVALID_ARGUMENT is
returned.
canonical_filter (str):
The filter applied to every search request when quality
improvement such as query expansion is needed. For example,
if a query does not have enough results, an expanded query
with
[SearchRequest.canonical_filter][google.cloud.retail.v2.SearchRequest.canonical_filter]
will be returned as a supplement of the original query. This
field is strongly recommended to achieve high search
quality.
See
[SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]
for more details about filter syntax.
order_by (str):
The order in which products are returned. Products can be
ordered by a field in an
[Product][google.cloud.retail.v2.Product] object. Leave it
unset if ordered by relevance. OrderBy expression is
case-sensitive. See more details at this `user
guide <https://cloud.google.com/retail/docs/filter-and-order#order>`__.
If this field is unrecognizable, an INVALID_ARGUMENT is
returned.
facet_specs (Sequence[google.cloud.retail_v2.types.SearchRequest.FacetSpec]):
Facet specifications for faceted search. If empty, no facets
are returned.
A maximum of 100 values are allowed. Otherwise, an
INVALID_ARGUMENT error is returned.
dynamic_facet_spec (google.cloud.retail_v2.types.SearchRequest.DynamicFacetSpec):
The specification for dynamically generated
facets. Notice that only textual facets can be
dynamically generated.
This feature requires additional allowlisting.
Contact Retail Search support team if you are
interested in using dynamic facet feature.
boost_spec (google.cloud.retail_v2.types.SearchRequest.BoostSpec):
Boost specification to boost certain products. See more
details at this `user
guide <https://cloud.google.com/retail/docs/boosting>`__.
Notice that if both [ServingConfig.boost_control_ids][] and
[SearchRequest.boost_spec] are set, the boost conditions
from both places are evaluated. If a search request matches
multiple boost conditions, the final boost score is equal to
the sum of the boost scores from all matched boost
conditions.
query_expansion_spec (google.cloud.retail_v2.types.SearchRequest.QueryExpansionSpec):
The query expansion specification that specifies the
conditions under which query expansion will occur. See more
details at this `user
guide <https://cloud.google.com/retail/docs/result-size#query_expansion>`__.
variant_rollup_keys (Sequence[str]):
The keys to fetch and rollup the matching
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product]s attributes. The
attributes from all the matching
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product]s are merged and
de-duplicated. Notice that rollup
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product]s attributes will
lead to extra query latency. Maximum number of keys is 10.
For
[FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo], a
fulfillment type and a fulfillment ID must be provided in
the format of "fulfillmentType.fulfillmentId". E.g., in
"pickupInStore.store123", "pickupInStore" is fulfillment
type and "store123" is the store ID.
Supported keys are:
- colorFamilies
- price
- originalPrice
- discount
- variantId
- inventory(place_id,price)
- inventory(place_id,attributes.key), where key is any key
in the [Product.inventories.attributes][] map.
- attributes.key, where key is any key in the
[Product.attributes][google.cloud.retail.v2.Product.attributes]
map.
- pickupInStore.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"pickup-in-store".
- shipToStore.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"ship-to-store".
- sameDayDelivery.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"same-day-delivery".
- nextDayDelivery.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"next-day-delivery".
- customFulfillment1.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"custom-type-1".
- customFulfillment2.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"custom-type-2".
- customFulfillment3.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"custom-type-3".
- customFulfillment4.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"custom-type-4".
- customFulfillment5.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"custom-type-5".
If this field is set to an invalid value other than these,
an INVALID_ARGUMENT error is returned.
page_categories (Sequence[str]):
The categories associated with a category page. Required for
category navigation queries to achieve good search quality.
The format should be the same as
[UserEvent.page_categories][google.cloud.retail.v2.UserEvent.page_categories];
To represent full path of category, use '>' sign to separate
different hierarchies. If '>' is part of the category name,
please replace it with other character(s).
Category pages include special pages such as sales or
promotions. For instance, a special sale page may have the
category hierarchy: "pageCategories" : ["Sales > 2017 Black
Friday Deals"].
search_mode (google.cloud.retail_v2.types.SearchRequest.SearchMode):
The search mode of the search request. If not
specified, a single search request triggers both
product search and faceted search.
"""
class SearchMode(proto.Enum):
r"""The search mode of each search request."""
SEARCH_MODE_UNSPECIFIED = 0
PRODUCT_SEARCH_ONLY = 1
FACETED_SEARCH_ONLY = 2
class FacetSpec(proto.Message):
r"""A facet specification to perform faceted search.
Attributes:
facet_key (google.cloud.retail_v2.types.SearchRequest.FacetSpec.FacetKey):
Required. The facet key specification.
limit (int):
Maximum of facet values that should be returned for this
facet. If unspecified, defaults to 20. The maximum allowed
value is 300. Values above 300 will be coerced to 300.
If this field is negative, an INVALID_ARGUMENT is returned.
excluded_filter_keys (Sequence[str]):
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this
field.
For example, suppose there are 100 products with color facet
"Red" and 200 products with color facet "Blue". A query
containing the filter "colorFamilies:ANY("Red")" and have
"colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
will by default return the "Red" with count 100.
If this field contains "colorFamilies", then the query
returns both the "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from
the filter.
A maximum of 100 values are allowed. Otherwise, an
INVALID_ARGUMENT error is returned.
enable_dynamic_position (bool):
Enables dynamic position for this facet. If set to true, the
position of this facet among all facets in the response is
determined by Google Retail Search. It will be ordered
together with dynamic facets if dynamic facets is enabled.
If set to false, the position of this facet in the response
will be the same as in the request, and it will be ranked
before the facets with dynamic position enable and all
dynamic facets.
For example, you may always want to have rating facet
returned in the response, but it's not necessarily to always
display the rating facet at the top. In that case, you can
set enable_dynamic_position to true so that the position of
rating facet in response will be determined by Google Retail
Search.
Another example, assuming you have the following facets in
the request:
- "rating", enable_dynamic_position = true
- "price", enable_dynamic_position = false
- "brands", enable_dynamic_position = false
And also you have a dynamic facets enable, which will
generate a facet 'gender'. Then the final order of the
facets in the response can be ("price", "brands", "rating",
"gender") or ("price", "brands", "gender", "rating") depends
on how Google Retail Search orders "gender" and "rating"
facets. However, notice that "price" and "brands" will
always be ranked at 1st and 2nd position since their
enable_dynamic_position are false.
"""
class FacetKey(proto.Message):
r"""Specifies how a facet is computed.
Attributes:
key (str):
Required. Supported textual and numerical facet keys in
[Product][google.cloud.retail.v2.Product] object, over which
the facet values are computed. Facet key is case-sensitive.
Allowed facet keys when
[FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
is not specified:
- textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
- numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,attributes.key)".
intervals (Sequence[google.cloud.retail_v2.types.Interval]):
Set only if values should be bucketized into
intervals. Must be set for facets with numerical
values. Must not be set for facet with text
values. Maximum number of intervals is 30.
restricted_values (Sequence[str]):
Only get facet for the given restricted values. For example,
when using "pickupInStore" as key and set restricted values
to ["store123", "store456"], only facets for "store123" and
"store456" are returned. Only supported on textual fields
and fulfillments. Maximum is 20.
Must be set for the fulfillment facet keys:
- pickupInStore
- shipToStore
- sameDayDelivery
- nextDayDelivery
- customFulfillment1
- customFulfillment2
- customFulfillment3
- customFulfillment4
- customFulfillment5
prefixes (Sequence[str]):
Only get facet values that start with the
given string prefix. For example, suppose
"categories" has three values "Women > Shoe",
"Women > Dress" and "Men > Shoe". If set
"prefixes" to "Women", the "categories" facet
will give only "Women > Shoe" and "Women >
Dress". Only supported on textual fields.
Maximum is 10.
contains (Sequence[str]):
Only get facet values that contains the given
strings. For example, suppose "categories" has
three values "Women > Shoe", "Women > Dress" and
"Men > Shoe". If set "contains" to "Shoe", the
"categories" facet will give only "Women > Shoe"
and "Men > Shoe". Only supported on textual
fields. Maximum is 10.
order_by (str):
The order in which [Facet.values][] are returned.
Allowed values are:
- "count desc", which means order by
[Facet.FacetValue.count][] descending.
- "value desc", which means order by
[Facet.FacetValue.value][] descending. Only applies to
textual facets.
If not set, textual values are sorted in `natural
order <https://en.wikipedia.org/wiki/Natural_sort_order>`__;
numerical intervals are sorted in the order given by
[FacetSpec.FacetKey.intervals][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.intervals];
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
are sorted in the order given by
[FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.restricted_values].
query (str):
The query that is used to compute facet for the given facet
key. When provided, it will override the default behavior of
facet computation. The query syntax is the same as a filter
expression. See
[SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]
for detail syntax and limitations. Notice that there is no
limitation on
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
when query is specified.
In the response, [FacetValue.value][] will be always "1" and
[FacetValue.count][] will be the number of results that
matches the query.
For example, you can set a customized facet for
"shipToStore", where
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is "customizedShipToStore", and
[FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
is "availability: ANY("IN_STOCK") AND shipToStore:
ANY("123")". Then the facet will count the products that are
both in stock and ship to store "123".
"""
key = proto.Field(
proto.STRING,
number=1,
)
intervals = proto.RepeatedField(
proto.MESSAGE,
number=2,
message=common.Interval,
)
restricted_values = proto.RepeatedField(
proto.STRING,
number=3,
)
prefixes = proto.RepeatedField(
proto.STRING,
number=8,
)
contains = proto.RepeatedField(
proto.STRING,
number=9,
)
order_by = proto.Field(
proto.STRING,
number=4,
)
query = proto.Field(
proto.STRING,
number=5,
)
facet_key = proto.Field(
proto.MESSAGE,
number=1,
message="SearchRequest.FacetSpec.FacetKey",
)
limit = proto.Field(
proto.INT32,
number=2,
)
excluded_filter_keys = proto.RepeatedField(
proto.STRING,
number=3,
)
enable_dynamic_position = proto.Field(
proto.BOOL,
number=4,
)
class DynamicFacetSpec(proto.Message):
r"""The specifications of dynamically generated facets.
Attributes:
mode (google.cloud.retail_v2.types.SearchRequest.DynamicFacetSpec.Mode):
Mode of the DynamicFacet feature. Defaults to
[Mode.DISABLED][google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode.DISABLED]
if it's unset.
"""
class Mode(proto.Enum):
r"""Enum to control DynamicFacet mode"""
MODE_UNSPECIFIED = 0
DISABLED = 1
ENABLED = 2
mode = proto.Field(
proto.ENUM,
number=1,
enum="SearchRequest.DynamicFacetSpec.Mode",
)
class BoostSpec(proto.Message):
r"""Boost specification to boost certain items.
Attributes:
condition_boost_specs (Sequence[google.cloud.retail_v2.types.SearchRequest.BoostSpec.ConditionBoostSpec]):
Condition boost specifications. If a product
matches multiple conditions in the
specifictions, boost scores from these
specifications are all applied and combined in a
non-linear way. Maximum number of specifications
is 10.
"""
class ConditionBoostSpec(proto.Message):
r"""Boost applies to products which match a condition.
Attributes:
condition (str):
An expression which specifies a boost condition. The syntax
and supported fields are the same as a filter expression.
See
[SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]
for detail syntax and limitations.
Examples:
- To boost products with product ID "product_1" or
"product_2", and color "Red" or "Blue":
- (id: ANY("product_1", "product_2")) AND
(colorFamilies: ANY("Red","Blue"))
boost (float):
Strength of the condition boost, which should be in [-1, 1].
Negative boost means demotion. Default is 0.0.
Setting to 1.0 gives the item a big promotion. However, it
does not necessarily mean that the boosted item will be the
top result at all times, nor that other items will be
excluded. Results could still be shown even when none of
them matches the condition. And results that are
significantly more relevant to the search query can still
trump your heavily favored but irrelevant items.
Setting to -1.0 gives the item a big demotion. However,
results that are deeply relevant might still be shown. The
item will have an upstream battle to get a fairly high
ranking, but it is not blocked out completely.
Setting to 0.0 means no boost applied. The boosting
condition is ignored.
"""
condition = proto.Field(
proto.STRING,
number=1,
)
boost = proto.Field(
proto.FLOAT,
number=2,
)
condition_boost_specs = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="SearchRequest.BoostSpec.ConditionBoostSpec",
)
class QueryExpansionSpec(proto.Message):
r"""Specification to determine under which conditions query
expansion should occur.
Attributes:
condition (google.cloud.retail_v2.types.SearchRequest.QueryExpansionSpec.Condition):
The condition under which query expansion should occur.
Default to
[Condition.DISABLED][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
pin_unexpanded_results (bool):
Whether to pin unexpanded results. If this
field is set to true, unexpanded products are
always at the top of the search results,
followed by the expanded results.
"""
class Condition(proto.Enum):
r"""Enum describing under which condition query expansion should
occur.
"""
CONDITION_UNSPECIFIED = 0
DISABLED = 1
AUTO = 3
condition = proto.Field(
proto.ENUM,
number=1,
enum="SearchRequest.QueryExpansionSpec.Condition",
)
pin_unexpanded_results = proto.Field(
proto.BOOL,
number=2,
)
placement = proto.Field(
proto.STRING,
number=1,
)
branch = proto.Field(
proto.STRING,
number=2,
)
query = proto.Field(
proto.STRING,
number=3,
)
visitor_id = proto.Field(
proto.STRING,
number=4,
)
user_info = proto.Field(
proto.MESSAGE,
number=5,
message=common.UserInfo,
)
page_size = proto.Field(
proto.INT32,
number=7,
)
page_token = proto.Field(
proto.STRING,
number=8,
)
offset = proto.Field(
proto.INT32,
number=9,
)
filter = proto.Field(
proto.STRING,
number=10,
)
canonical_filter = proto.Field(
proto.STRING,
number=28,
)
order_by = proto.Field(
proto.STRING,
number=11,
)
facet_specs = proto.RepeatedField(
proto.MESSAGE,
number=12,
message=FacetSpec,
)
dynamic_facet_spec = proto.Field(
proto.MESSAGE,
number=21,
message=DynamicFacetSpec,
)
boost_spec = proto.Field(
proto.MESSAGE,
number=13,
message=BoostSpec,
)
query_expansion_spec = proto.Field(
proto.MESSAGE,
number=14,
message=QueryExpansionSpec,
)
variant_rollup_keys = proto.RepeatedField(
proto.STRING,
number=17,
)
page_categories = proto.RepeatedField(
proto.STRING,
number=23,
)
search_mode = proto.Field(
proto.ENUM,
number=31,
enum=SearchMode,
)
class Result(proto.Message):
r"""The inference result which includes an objective metric to
optimize and the confidence interval.
Attributes:
version_metrics (Sequence[google.cloud.dialogflowcx_v3beta1.types.Experiment.Result.VersionMetrics]):
Version variants and metrics.
last_update_time (google.protobuf.timestamp_pb2.Timestamp):
The last time the experiment's stats data was
updated. Will have default value if stats have
never been computed for this experiment.
"""
class MetricType(proto.Enum):
r"""Types of ratio-based metric for Dialogflow experiment."""
METRIC_UNSPECIFIED = 0
CONTAINED_SESSION_NO_CALLBACK_RATE = 1
LIVE_AGENT_HANDOFF_RATE = 2
CALLBACK_SESSION_RATE = 3
ABANDONED_SESSION_RATE = 4
SESSION_END_RATE = 5
class CountType(proto.Enum):
r"""types of count-based metric for Dialogflow experiment."""
COUNT_TYPE_UNSPECIFIED = 0
TOTAL_NO_MATCH_COUNT = 1
TOTAL_TURN_COUNT = 2
AVERAGE_TURN_COUNT = 3
class ConfidenceInterval(proto.Message):
r"""A confidence interval is a range of possible values for the
experiment objective you are trying to measure.
Attributes:
confidence_level (float):
The confidence level used to construct the
interval, i.e. there is X% chance that the true
value is within this interval.
ratio (float):
The percent change between an experiment
metric's value and the value for its control.
lower_bound (float):
Lower bound of the interval.
upper_bound (float):
Upper bound of the interval.
"""
confidence_level = proto.Field(proto.DOUBLE, number=1,)
ratio = proto.Field(proto.DOUBLE, number=2,)
lower_bound = proto.Field(proto.DOUBLE, number=3,)
upper_bound = proto.Field(proto.DOUBLE, number=4,)
class Metric(proto.Message):
r"""Metric and corresponding confidence intervals.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
type_ (google.cloud.dialogflowcx_v3beta1.types.Experiment.Result.MetricType):
Ratio-based metric type. Only one of type or count_type is
specified in each Metric.
count_type (google.cloud.dialogflowcx_v3beta1.types.Experiment.Result.CountType):
Count-based metric type. Only one of type or count_type is
specified in each Metric.
ratio (float):
Ratio value of a metric.
This field is a member of `oneof`_ ``value``.
count (float):
Count value of a metric.
This field is a member of `oneof`_ ``value``.
confidence_interval (google.cloud.dialogflowcx_v3beta1.types.Experiment.Result.ConfidenceInterval):
The probability that the treatment is better
than all other treatments in the experiment
"""
type_ = proto.Field(
proto.ENUM, number=1, enum="Experiment.Result.MetricType",
)
count_type = proto.Field(
proto.ENUM, number=5, enum="Experiment.Result.CountType",
)
ratio = proto.Field(proto.DOUBLE, number=2, oneof="value",)
count = proto.Field(proto.DOUBLE, number=4, oneof="value",)
confidence_interval = proto.Field(
proto.MESSAGE, number=3, message="Experiment.Result.ConfidenceInterval",
)
class VersionMetrics(proto.Message):
r"""Version variant and associated metrics.
Attributes:
version (str):
The name of the flow
[Version][google.cloud.dialogflow.cx.v3beta1.Version].
Format:
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
metrics (Sequence[google.cloud.dialogflowcx_v3beta1.types.Experiment.Result.Metric]):
The metrics and corresponding confidence
intervals in the inference result.
session_count (int):
Number of sessions that were allocated to
this version.
"""
version = proto.Field(proto.STRING, number=1,)
metrics = proto.RepeatedField(
proto.MESSAGE, number=2, message="Experiment.Result.Metric",
)
session_count = proto.Field(proto.INT32, number=3,)
version_metrics = proto.RepeatedField(
proto.MESSAGE, number=1, message="Experiment.Result.VersionMetrics",
)
last_update_time = proto.Field(
proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,
)
class SearchResponse(proto.Message):
r"""Response message for
[SearchService.Search][google.cloud.retail.v2.SearchService.Search]
method.
Attributes:
results (Sequence[google.cloud.retail_v2.types.SearchResponse.SearchResult]):
A list of matched items. The order represents
the ranking.
facets (Sequence[google.cloud.retail_v2.types.SearchResponse.Facet]):
Results of facets requested by user.
total_size (int):
The estimated total count of matched items irrespective of
pagination. The count of
[results][google.cloud.retail.v2.SearchResponse.results]
returned by pagination may be less than the
[total_size][google.cloud.retail.v2.SearchResponse.total_size]
that matches.
corrected_query (str):
If spell correction applies, the corrected
query. Otherwise, empty.
attribution_token (str):
A unique search token. This should be included in the
[UserEvent][google.cloud.retail.v2.UserEvent] logs resulting
from this search, which enables accurate attribution of
search model performance.
next_page_token (str):
A token that can be sent as
[SearchRequest.page_token][google.cloud.retail.v2.SearchRequest.page_token]
to retrieve the next page. If this field is omitted, there
are no subsequent pages.
query_expansion_info (google.cloud.retail_v2.types.SearchResponse.QueryExpansionInfo):
Query expansion information for the returned
results.
redirect_uri (str):
The URI of a customer-defined redirect page. If redirect
action is triggered, no search will be performed, and only
[redirect_uri][google.cloud.retail.v2.SearchResponse.redirect_uri]
and
[attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
will be set in the response.
"""
class SearchResult(proto.Message):
r"""Represents the search results.
Attributes:
id (str):
[Product.id][google.cloud.retail.v2.Product.id] of the
searched [Product][google.cloud.retail.v2.Product].
product (google.cloud.retail_v2.types.Product):
The product data snippet in the search response. Only
[Product.name][google.cloud.retail.v2.Product.name] is
guaranteed to be populated.
[Product.variants][google.cloud.retail.v2.Product.variants]
contains the product variants that match the search query.
If there are multiple product variants matching the query,
top 5 most relevant product variants are returned and
ordered by relevancy.
If relevancy can be deternmined, use
[matching_variant_fields][google.cloud.retail.v2.SearchResponse.SearchResult.matching_variant_fields]
to look up matched product variants fields. If relevancy
cannot be determined, e.g. when searching "shoe" all
products in a shoe product can be a match, 5 product
variants are returned but order is meaningless.
matching_variant_count (int):
The count of matched
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product]s.
matching_variant_fields (Sequence[google.cloud.retail_v2.types.SearchResponse.SearchResult.MatchingVariantFieldsEntry]):
If a [variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product] matches the search
query, this map indicates which
[Product][google.cloud.retail.v2.Product] fields are
matched. The key is the
[Product.name][google.cloud.retail.v2.Product.name], the
value is a field mask of the matched
[Product][google.cloud.retail.v2.Product] fields. If matched
attributes cannot be determined, this map will be empty.
For example, a key "sku1" with field mask
"products.color_info" indicates there is a match between
"sku1" [ColorInfo][google.cloud.retail.v2.ColorInfo] and the
query.
variant_rollup_values (Sequence[google.cloud.retail_v2.types.SearchResponse.SearchResult.VariantRollupValuesEntry]):
The rollup matching
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product] attributes. The
key is one of the
[SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
The values are the merged and de-duplicated
[Product][google.cloud.retail.v2.Product] attributes. Notice
that the rollup values are respect filter. For example, when
filtering by "colorFamilies:ANY("red")" and rollup
"colorFamilies", only "red" is returned.
For textual and numerical attributes, the rollup values is a
list of string or double values with type
[google.protobuf.ListValue][google.protobuf.ListValue]. For
example, if there are two variants with colors "red" and
"blue", the rollup values are
::
{ key: "colorFamilies"
value {
list_value {
values { string_value: "red" }
values { string_value: "blue" }
}
}
}
For
[FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo],
the rollup values is a double value with type
[google.protobuf.Value][google.protobuf.Value]. For example,
``{key: "pickupInStore.store1" value { number_value: 10 }}``
means a there are 10 variants in this product are available
in the store "store1".
"""
id = proto.Field(
proto.STRING,
number=1,
)
product = proto.Field(
proto.MESSAGE,
number=2,
message=gcr_product.Product,
)
matching_variant_count = proto.Field(
proto.INT32,
number=3,
)
matching_variant_fields = proto.MapField(
proto.STRING,
proto.MESSAGE,
number=4,
message=field_mask_pb2.FieldMask,
)
variant_rollup_values = proto.MapField(
proto.STRING,
proto.MESSAGE,
number=5,
message=struct_pb2.Value,
)
class Facet(proto.Message):
r"""A facet result.
Attributes:
key (str):
The key for this facet. E.g., "colorFamilies"
or "price" or "attributes.attr1".
values (Sequence[google.cloud.retail_v2.types.SearchResponse.Facet.FacetValue]):
The facet values for this field.
dynamic_facet (bool):
Whether the facet is dynamically generated.
"""
class FacetValue(proto.Message):
r"""A facet value which contains value names and their count.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
value (str):
Text value of a facet, such as "Black" for
facet "colorFamilies".
This field is a member of `oneof`_ ``facet_value``.
interval (google.cloud.retail_v2.types.Interval):
Interval value for a facet, such as [10, 20) for facet
"price".
This field is a member of `oneof`_ ``facet_value``.
count (int):
Number of items that have this facet value.
"""
value = proto.Field(
proto.STRING,
number=1,
oneof="facet_value",
)
interval = proto.Field(
proto.MESSAGE,
number=2,
oneof="facet_value",
message=common.Interval,
)
count = proto.Field(
proto.INT64,
number=3,
)
key = proto.Field(
proto.STRING,
number=1,
)
values = proto.RepeatedField(
proto.MESSAGE,
number=2,
message="SearchResponse.Facet.FacetValue",
)
dynamic_facet = proto.Field(
proto.BOOL,
number=3,
)
class QueryExpansionInfo(proto.Message):
r"""Information describing query expansion including whether
expansion has occurred.
Attributes:
expanded_query (bool):
Bool describing whether query expansion has
occurred.
pinned_result_count (int):
Number of pinned results. This field will only be set when
expansion happens and
[SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.pin_unexpanded_results]
is set to true.
"""
expanded_query = proto.Field(
proto.BOOL,
number=1,
)
pinned_result_count = proto.Field(
proto.INT64,
number=2,
)
@property
def raw_page(self):
return self
results = proto.RepeatedField(
proto.MESSAGE,
number=1,
message=SearchResult,
)
facets = proto.RepeatedField(
proto.MESSAGE,
number=2,
message=Facet,
)
total_size = proto.Field(
proto.INT32,
number=3,
)
corrected_query = proto.Field(
proto.STRING,
number=4,
)
attribution_token = proto.Field(
proto.STRING,
number=5,
)
next_page_token = proto.Field(
proto.STRING,
number=6,
)
query_expansion_info = proto.Field(
proto.MESSAGE,
number=7,
message=QueryExpansionInfo,
)
redirect_uri = proto.Field(
proto.STRING,
number=10,
)
class Experiment(proto.Message):
r"""Represents an experiment in an environment.
Attributes:
name (str):
The name of the experiment.
Format: projects/<Project
ID>/locations/<Location ID>/agents/<Agent
ID>/environments/<Environment
ID>/experiments/<Experiment ID>..
display_name (str):
Required. The human-readable name of the
experiment (unique in an environment). Limit of
64 characters.
description (str):
The human-readable description of the
experiment.
state (google.cloud.dialogflowcx_v3beta1.types.Experiment.State):
The current state of the experiment.
Transition triggered by
Experiments.StartExperiment: DRAFT->RUNNING.
Transition triggered by
Experiments.CancelExperiment: DRAFT->DONE or
RUNNING->DONE.
definition (google.cloud.dialogflowcx_v3beta1.types.Experiment.Definition):
The definition of the experiment.
rollout_config (google.cloud.dialogflowcx_v3beta1.types.RolloutConfig):
The configuration for auto rollout. If set,
there should be exactly two variants in the
experiment (control variant being the default
version of the flow), the traffic allocation for
the non-control variant will gradually increase
to 100% when conditions are met, and eventually
replace the control variant to become the
default version of the flow.
rollout_state (google.cloud.dialogflowcx_v3beta1.types.RolloutState):
State of the auto rollout process.
rollout_failure_reason (str):
The reason why rollout has failed. Should only be set when
state is ROLLOUT_FAILED.
result (google.cloud.dialogflowcx_v3beta1.types.Experiment.Result):
Inference result of the experiment.
create_time (google.protobuf.timestamp_pb2.Timestamp):
Creation time of this experiment.
start_time (google.protobuf.timestamp_pb2.Timestamp):
Start time of this experiment.
end_time (google.protobuf.timestamp_pb2.Timestamp):
End time of this experiment.
last_update_time (google.protobuf.timestamp_pb2.Timestamp):
Last update time of this experiment.
experiment_length (google.protobuf.duration_pb2.Duration):
Maximum number of days to run the experiment.
If auto-rollout is not enabled, default value
and maximum will be 30 days. If auto-rollout is
enabled, default value and maximum will be 6
days.
variants_history (Sequence[google.cloud.dialogflowcx_v3beta1.types.VariantsHistory]):
The history of updates to the experiment
variants.
"""
class State(proto.Enum):
r"""The state of the experiment."""
STATE_UNSPECIFIED = 0
DRAFT = 1
RUNNING = 2
DONE = 3
ROLLOUT_FAILED = 4
class Definition(proto.Message):
r"""Definition of the experiment.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
condition (str):
The condition defines which subset of sessions are selected
for this experiment. If not specified, all sessions are
eligible. E.g. "query_input.language_code=en" See the
`conditions
reference <https://cloud.google.com/dialogflow/cx/docs/reference/condition>`__.
version_variants (google.cloud.dialogflowcx_v3beta1.types.VersionVariants):
The flow versions as the variants of this
experiment.
This field is a member of `oneof`_ ``variants``.
"""
condition = proto.Field(proto.STRING, number=1,)
version_variants = proto.Field(
proto.MESSAGE, number=2, oneof="variants", message="VersionVariants",
)
class Result(proto.Message):
r"""The inference result which includes an objective metric to
optimize and the confidence interval.
Attributes:
version_metrics (Sequence[google.cloud.dialogflowcx_v3beta1.types.Experiment.Result.VersionMetrics]):
Version variants and metrics.
last_update_time (google.protobuf.timestamp_pb2.Timestamp):
The last time the experiment's stats data was
updated. Will have default value if stats have
never been computed for this experiment.
"""
class MetricType(proto.Enum):
r"""Types of ratio-based metric for Dialogflow experiment."""
METRIC_UNSPECIFIED = 0
CONTAINED_SESSION_NO_CALLBACK_RATE = 1
LIVE_AGENT_HANDOFF_RATE = 2
CALLBACK_SESSION_RATE = 3
ABANDONED_SESSION_RATE = 4
SESSION_END_RATE = 5
class CountType(proto.Enum):
r"""types of count-based metric for Dialogflow experiment."""
COUNT_TYPE_UNSPECIFIED = 0
TOTAL_NO_MATCH_COUNT = 1
TOTAL_TURN_COUNT = 2
AVERAGE_TURN_COUNT = 3
class ConfidenceInterval(proto.Message):
r"""A confidence interval is a range of possible values for the
experiment objective you are trying to measure.
Attributes:
confidence_level (float):
The confidence level used to construct the
interval, i.e. there is X% chance that the true
value is within this interval.
ratio (float):
The percent change between an experiment
metric's value and the value for its control.
lower_bound (float):
Lower bound of the interval.
upper_bound (float):
Upper bound of the interval.
"""
confidence_level = proto.Field(proto.DOUBLE, number=1,)
ratio = proto.Field(proto.DOUBLE, number=2,)
lower_bound = proto.Field(proto.DOUBLE, number=3,)
upper_bound = proto.Field(proto.DOUBLE, number=4,)
class Metric(proto.Message):
r"""Metric and corresponding confidence intervals.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
type_ (google.cloud.dialogflowcx_v3beta1.types.Experiment.Result.MetricType):
Ratio-based metric type. Only one of type or count_type is
specified in each Metric.
count_type (google.cloud.dialogflowcx_v3beta1.types.Experiment.Result.CountType):
Count-based metric type. Only one of type or count_type is
specified in each Metric.
ratio (float):
Ratio value of a metric.
This field is a member of `oneof`_ ``value``.
count (float):
Count value of a metric.
This field is a member of `oneof`_ ``value``.
confidence_interval (google.cloud.dialogflowcx_v3beta1.types.Experiment.Result.ConfidenceInterval):
The probability that the treatment is better
than all other treatments in the experiment
"""
type_ = proto.Field(
proto.ENUM, number=1, enum="Experiment.Result.MetricType",
)
count_type = proto.Field(
proto.ENUM, number=5, enum="Experiment.Result.CountType",
)
ratio = proto.Field(proto.DOUBLE, number=2, oneof="value",)
count = proto.Field(proto.DOUBLE, number=4, oneof="value",)
confidence_interval = proto.Field(
proto.MESSAGE, number=3, message="Experiment.Result.ConfidenceInterval",
)
class VersionMetrics(proto.Message):
r"""Version variant and associated metrics.
Attributes:
version (str):
The name of the flow
[Version][google.cloud.dialogflow.cx.v3beta1.Version].
Format:
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>``.
metrics (Sequence[google.cloud.dialogflowcx_v3beta1.types.Experiment.Result.Metric]):
The metrics and corresponding confidence
intervals in the inference result.
session_count (int):
Number of sessions that were allocated to
this version.
"""
version = proto.Field(proto.STRING, number=1,)
metrics = proto.RepeatedField(
proto.MESSAGE, number=2, message="Experiment.Result.Metric",
)
session_count = proto.Field(proto.INT32, number=3,)
version_metrics = proto.RepeatedField(
proto.MESSAGE, number=1, message="Experiment.Result.VersionMetrics",
)
last_update_time = proto.Field(
proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,
)
name = proto.Field(proto.STRING, number=1,)
display_name = proto.Field(proto.STRING, number=2,)
description = proto.Field(proto.STRING, number=3,)
state = proto.Field(proto.ENUM, number=4, enum=State,)
definition = proto.Field(proto.MESSAGE, number=5, message=Definition,)
rollout_config = proto.Field(proto.MESSAGE, number=14, message="RolloutConfig",)
rollout_state = proto.Field(proto.MESSAGE, number=15, message="RolloutState",)
rollout_failure_reason = proto.Field(proto.STRING, number=16,)
result = proto.Field(proto.MESSAGE, number=6, message=Result,)
create_time = proto.Field(proto.MESSAGE, number=7, message=timestamp_pb2.Timestamp,)
start_time = proto.Field(proto.MESSAGE, number=8, message=timestamp_pb2.Timestamp,)
end_time = proto.Field(proto.MESSAGE, number=9, message=timestamp_pb2.Timestamp,)
last_update_time = proto.Field(
proto.MESSAGE, number=10, message=timestamp_pb2.Timestamp,
)
experiment_length = proto.Field(
proto.MESSAGE, number=11, message=duration_pb2.Duration,
)
variants_history = proto.RepeatedField(
proto.MESSAGE, number=12, message="VariantsHistory",
)
class Facet(proto.Message):
r"""A facet result.
Attributes:
key (str):
The key for this facet. E.g., "colorFamilies"
or "price" or "attributes.attr1".
values (Sequence[google.cloud.retail_v2.types.SearchResponse.Facet.FacetValue]):
The facet values for this field.
dynamic_facet (bool):
Whether the facet is dynamically generated.
"""
class FacetValue(proto.Message):
r"""A facet value which contains value names and their count.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
value (str):
Text value of a facet, such as "Black" for
facet "colorFamilies".
This field is a member of `oneof`_ ``facet_value``.
interval (google.cloud.retail_v2.types.Interval):
Interval value for a facet, such as [10, 20) for facet
"price".
This field is a member of `oneof`_ ``facet_value``.
count (int):
Number of items that have this facet value.
"""
value = proto.Field(
proto.STRING,
number=1,
oneof="facet_value",
)
interval = proto.Field(
proto.MESSAGE,
number=2,
oneof="facet_value",
message=common.Interval,
)
count = proto.Field(
proto.INT64,
number=3,
)
key = proto.Field(
proto.STRING,
number=1,
)
values = proto.RepeatedField(
proto.MESSAGE,
number=2,
message="SearchResponse.Facet.FacetValue",
)
dynamic_facet = proto.Field(
proto.BOOL,
number=3,
)
class OperationMetadata(proto.Message):
r"""Represents the metadata of the long-running operation.
Attributes:
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. The time the operation was
created.
end_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. The time the operation finished
running.
target (str):
Output only. Server-defined resource path for
the target of the operation.
verb (str):
Output only. Name of the verb executed by the
operation.
status_message (str):
Output only. Human-readable status of the
operation, if any.
requested_cancellation (bool):
Output only. Identifies whether the user has requested
cancellation of the operation. Operations that have
successfully been cancelled have [Operation.error][] value
with a [google.rpc.Status.code][google.rpc.Status.code] of
1, corresponding to ``Code.CANCELLED``.
api_version (str):
Output only. API version used to start the
operation.
unreachable (Sequence[str]):
Output only. List of Locations that could not
be reached.
operation_status (Mapping[str, google.cloud.gaming_v1beta.types.OperationStatus]):
Output only. Operation status for Game
Services API operations. Operation status is in
the form of key-value pairs where keys are
resource IDs and the values show the status of
the operation. In case of failures, the value
includes an error code and error message.
"""
create_time = proto.Field(
proto.MESSAGE,
number=1,
message=timestamp_pb2.Timestamp,
)
end_time = proto.Field(
proto.MESSAGE,
number=2,
message=timestamp_pb2.Timestamp,
)
target = proto.Field(
proto.STRING,
number=3,
)
verb = proto.Field(
proto.STRING,
number=4,
)
status_message = proto.Field(
proto.STRING,
number=5,
)
requested_cancellation = proto.Field(
proto.BOOL,
number=6,
)
api_version = proto.Field(
proto.STRING,
number=7,
)
unreachable = proto.RepeatedField(
proto.STRING,
number=8,
)
operation_status = proto.MapField(
proto.STRING,
proto.MESSAGE,
number=9,
message="OperationStatus",
)
