From 7d3c54517636660cbb14df25f4f829cb250d2881 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Wed, 27 May 2020 00:38:06 +0000 Subject: [PATCH] Autogenerated update (2020-05-27) Update: - billingbudgets_v1beta1 - cloudtasks_v2 - fitness_v1 - healthcare_v1 - healthcare_v1beta1 - homegraph_v1 - iam_v1 --- .../google/apis/billingbudgets_v1beta1.rb | 2 +- .../apis/billingbudgets_v1beta1/classes.rb | 6 +- generated/google/apis/cloudtasks_v2.rb | 2 +- .../google/apis/cloudtasks_v2/classes.rb | 4 +- generated/google/apis/fitness_v1.rb | 8 +- generated/google/apis/fitness_v1/classes.rb | 343 ++++++++------- generated/google/apis/fitness_v1/service.rb | 402 ++++++++---------- generated/google/apis/healthcare_v1.rb | 2 +- .../google/apis/healthcare_v1/classes.rb | 63 +-- .../google/apis/healthcare_v1/service.rb | 90 ++-- generated/google/apis/healthcare_v1beta1.rb | 2 +- .../google/apis/healthcare_v1beta1/classes.rb | 72 ++-- .../google/apis/healthcare_v1beta1/service.rb | 306 ++++++------- generated/google/apis/homegraph_v1.rb | 2 +- generated/google/apis/homegraph_v1/classes.rb | 3 + generated/google/apis/iam_v1.rb | 2 +- generated/google/apis/iam_v1/classes.rb | 36 +- generated/google/apis/iam_v1/service.rb | 7 + 18 files changed, 718 insertions(+), 634 deletions(-) diff --git a/generated/google/apis/billingbudgets_v1beta1.rb b/generated/google/apis/billingbudgets_v1beta1.rb index e344f1642..cb958d5d1 100644 --- a/generated/google/apis/billingbudgets_v1beta1.rb +++ b/generated/google/apis/billingbudgets_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/billing/docs/how-to/budget-api-overview module BillingbudgetsV1beta1 VERSION = 'V1beta1' - REVISION = '20200516' + REVISION = '20200522' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/billingbudgets_v1beta1/classes.rb b/generated/google/apis/billingbudgets_v1beta1/classes.rb index 549f53589..562a555f5 100644 --- a/generated/google/apis/billingbudgets_v1beta1/classes.rb +++ b/generated/google/apis/billingbudgets_v1beta1/classes.rb @@ -192,9 +192,9 @@ module Google # Optional. A single label and value pair specifying that usage from only this # set of - # labeled resources should be included in the budget. Multiple entries or - # multiple values per entry are not allowed. If omitted, the report will - # include all labeled and unlabeled usage. + # labeled resources should be included in the budget. Currently, multiple + # entries or multiple values per entry are not allowed. If omitted, the + # report will include all labeled and unlabeled usage. # Corresponds to the JSON property `labels` # @return [Hash>] attr_accessor :labels diff --git a/generated/google/apis/cloudtasks_v2.rb b/generated/google/apis/cloudtasks_v2.rb index 1b7c59559..15328ee5c 100644 --- a/generated/google/apis/cloudtasks_v2.rb +++ b/generated/google/apis/cloudtasks_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tasks/ module CloudtasksV2 VERSION = 'V2' - REVISION = '20200505' + REVISION = '20200513' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtasks_v2/classes.rb b/generated/google/apis/cloudtasks_v2/classes.rb index d693070e3..6508ce94b 100644 --- a/generated/google/apis/cloudtasks_v2/classes.rb +++ b/generated/google/apis/cloudtasks_v2/classes.rb @@ -1601,8 +1601,8 @@ module Google # respond by this deadline then the request is cancelled and the attempt # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the # task according to the RetryConfig. - # Note that when the request is cancelled, Cloud Tasks will stop listing for - # the response, but whether the worker stops processing depends on the + # Note that when the request is cancelled, Cloud Tasks will stop listening + # for the response, but whether the worker stops processing depends on the # worker. For example, if the worker is stuck, it may not react to cancelled # requests. # The default and maximum values depend on the type of request: diff --git a/generated/google/apis/fitness_v1.rb b/generated/google/apis/fitness_v1.rb index f8ffa34ca..5333ebf2c 100644 --- a/generated/google/apis/fitness_v1.rb +++ b/generated/google/apis/fitness_v1.rb @@ -18,14 +18,14 @@ require 'google/apis/fitness_v1/representations.rb' module Google module Apis - # Fitness + # Fitness API # - # Stores and accesses user data in the fitness store from apps on any platform. + # The Fitness API for managing users' fitness tracking data. # - # @see https://developers.google.com/fit/rest/ + # @see https://developers.google.com/fit/rest/v1/get-started module FitnessV1 VERSION = 'V1' - REVISION = '20200220' + REVISION = '20200522' # Use Google Fit to see and store your physical activity data AUTH_FITNESS_ACTIVITY_READ = 'https://www.googleapis.com/auth/fitness.activity.read' diff --git a/generated/google/apis/fitness_v1/classes.rb b/generated/google/apis/fitness_v1/classes.rb index 0151ce89b..63bdb72f4 100644 --- a/generated/google/apis/fitness_v1/classes.rb +++ b/generated/google/apis/fitness_v1/classes.rb @@ -36,7 +36,8 @@ module Google # @return [Array] attr_accessor :dataset - # The end time for the aggregated data, in milliseconds since epoch, inclusive. + # The end time for the aggregated data, in milliseconds since epoch, + # inclusive. # Corresponds to the JSON property `endTimeMillis` # @return [Fixnum] attr_accessor :end_time_millis @@ -47,7 +48,8 @@ module Google # @return [Google::Apis::FitnessV1::Session] attr_accessor :session - # The start time for the aggregated data, in milliseconds since epoch, inclusive. + # The start time for the aggregated data, in milliseconds since epoch, + # inclusive. # Corresponds to the JSON property `startTimeMillis` # @return [Fixnum] attr_accessor :start_time_millis @@ -78,21 +80,22 @@ module Google include Google::Apis::Core::Hashable # A data source ID to aggregate. Only data from the specified data source ID - # will be included in the aggregation. If specified, this data source must exist; - # the OAuth scopes in the supplied credentials must grant read access to this - # data type. The dataset in the response will have the same data source ID. Note: - # Data can be aggregated by either the dataTypeName or the dataSourceId, not - # both. + # will be included in the aggregation. If specified, this data source must + # exist; the OAuth scopes in the supplied credentials must grant read access + # to this data type. The dataset in the response will have the same data + # source ID. Note: Data can be aggregated by either the dataTypeName or the + # dataSourceId, not both. # Corresponds to the JSON property `dataSourceId` # @return [String] attr_accessor :data_source_id # The data type to aggregate. All data sources providing this data type will - # contribute data to the aggregation. The response will contain a single dataset - # for this data type name. The dataset will have a data source ID of derived:: - # com.google.android.gms:aggregated. If the user has no data for this data type, - # an empty data set will be returned. Note: Data can be aggregated by either the - # dataTypeName or the dataSourceId, not both. + # contribute data to the aggregation. The response will contain a single + # dataset for this data type name. The dataset will have a data source ID of + # derived::com.google.android.gms:aggregated. + # If the user has no data for this data type, an empty data set will be + # returned. Note: Data can be aggregated by either the dataTypeName or the + # dataSourceId, not both. # Corresponds to the JSON property `dataTypeName` # @return [String] attr_accessor :data_type_name @@ -112,27 +115,28 @@ module Google class AggregateRequest include Google::Apis::Core::Hashable - # The specification of data to be aggregated. At least one aggregateBy spec must - # be provided. All data that is specified will be aggregated using the same - # bucketing criteria. There will be one dataset in the response for every - # aggregateBy spec. + # The specification of data to be aggregated. At least one aggregateBy spec + # must be provided. All data that is specified will be aggregated using the + # same bucketing criteria. There will be one dataset in the response for + # every aggregateBy spec. # Corresponds to the JSON property `aggregateBy` # @return [Array] attr_accessor :aggregate_by # Specifies that data be aggregated each activity segment recored for a user. # Similar to bucketByActivitySegment, but bucketing is done for each activity - # segment rather than all segments of the same type. Mutually exclusive of other - # bucketing specifications. + # segment rather than all segments of the same type. Mutually exclusive of + # other bucketing specifications. # Corresponds to the JSON property `bucketByActivitySegment` # @return [Google::Apis::FitnessV1::BucketByActivity] attr_accessor :bucket_by_activity_segment - # Specifies that data be aggregated by the type of activity being performed when - # the data was recorded. All data that was recorded during a certain activity - # type (for the given time range) will be aggregated into the same bucket. Data - # that was recorded while the user was not active will not be included in the - # response. Mutually exclusive of other bucketing specifications. + # Specifies that data be aggregated by the type of activity being performed + # when the data was recorded. All data that was recorded during a certain + # activity type (for the given time range) will be aggregated into the same + # bucket. Data that was recorded while the user was not active will not be + # included in the response. Mutually exclusive of other bucketing + # specifications. # Corresponds to the JSON property `bucketByActivityType` # @return [Google::Apis::FitnessV1::BucketByActivity] attr_accessor :bucket_by_activity_type @@ -150,8 +154,9 @@ module Google # @return [Google::Apis::FitnessV1::BucketByTime] attr_accessor :bucket_by_time - # The end of a window of time. Data that intersects with this time window will - # be aggregated. The time is in milliseconds since epoch, inclusive. + # The end of a window of time. Data that intersects with this time + # window will be aggregated. The time is in milliseconds since epoch, + # inclusive. # Corresponds to the JSON property `endTimeMillis` # @return [Fixnum] attr_accessor :end_time_millis @@ -161,8 +166,9 @@ module Google # @return [Array] attr_accessor :filtered_data_quality_standard - # The start of a window of time. Data that intersects with this time window will - # be aggregated. The time is in milliseconds since epoch, inclusive. + # The start of a window of time. Data that intersects with this time + # window will be aggregated. The time is in milliseconds since epoch, + # inclusive. # Corresponds to the JSON property `startTimeMillis` # @return [Fixnum] attr_accessor :start_time_millis @@ -212,18 +218,18 @@ module Google # @return [String] attr_accessor :details_url - # The name of this application. This is required for REST clients, but we do not - # enforce uniqueness of this name. It is provided as a matter of convenience for - # other developers who would like to identify which REST created an Application - # or Data Source. + # The name of this application. This is required for REST clients, but we + # do not enforce uniqueness of this name. It is provided as a matter of + # convenience for other developers who would like to identify which REST + # created an Application or Data Source. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Package name for this application. This is used as a unique identifier when - # created by Android applications, but cannot be specified by REST clients. REST - # clients will have their developer project number reflected into the Data - # Source data stream IDs, instead of the packageName. + # Package name for this application. This is used as a unique + # identifier when created by Android applications, but cannot be specified + # by REST clients. REST clients will have their developer project number + # reflected into the Data Source data stream IDs, instead of the packageName. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name @@ -251,14 +257,15 @@ module Google class BucketByActivity include Google::Apis::Core::Hashable - # The default activity stream will be used if a specific activityDataSourceId is - # not specified. + # The default activity stream will be used if a specific activityDataSourceId + # is not specified. # Corresponds to the JSON property `activityDataSourceId` # @return [String] attr_accessor :activity_data_source_id # Specifies that only activity segments of duration longer than - # minDurationMillis are considered and used as a container for aggregated data. + # minDurationMillis are considered and used as a container for aggregated + # data. # Corresponds to the JSON property `minDurationMillis` # @return [Fixnum] attr_accessor :min_duration_millis @@ -299,8 +306,8 @@ module Google include Google::Apis::Core::Hashable # Specifies that result buckets aggregate data by exactly durationMillis time - # frames. Time frames that contain no data will be included in the response with - # an empty dataset. + # frames. Time frames that contain no data will be included in the response + # with an empty dataset. # Corresponds to the JSON property `durationMillis` # @return [Fixnum] attr_accessor :duration_millis @@ -352,14 +359,14 @@ module Google end end - # Represents a single data point, generated by a particular data source. A data - # point holds a value for each field, an end timestamp and an optional start - # time. The exact semantics of each of these attributes are specified in the - # documentation for the particular data type. + # Represents a single data point, generated by a particular data source. A + # data point holds a value for each field, an end timestamp and an optional + # start time. The exact semantics of each of these attributes are specified in + # the documentation for the particular data type. # A data point can represent an instantaneous measurement, reading or input - # observation, as well as averages or aggregates over a time interval. Check the - # data type documentation to determine which is the case for a particular data - # type. + # observation, as well as averages or aggregates over a time interval. Check + # the data type documentation to determine which is the case for a particular + # data type. # Data points always contain one value for each field of the data type. class DataPoint include Google::Apis::Core::Hashable @@ -374,25 +381,25 @@ module Google # @return [String] attr_accessor :data_type_name - # The end time of the interval represented by this data point, in nanoseconds - # since epoch. + # The end time of the interval represented by this data point, in + # nanoseconds since epoch. # Corresponds to the JSON property `endTimeNanos` # @return [Fixnum] attr_accessor :end_time_nanos - # Indicates the last time this data point was modified. Useful only in contexts - # where we are listing the data changes, rather than representing the current - # state of the data. + # Indicates the last time this data point was modified. Useful only in + # contexts where we are listing the data changes, rather than representing + # the current state of the data. # Corresponds to the JSON property `modifiedTimeMillis` # @return [Fixnum] attr_accessor :modified_time_millis - # If the data point is contained in a dataset for a derived data source, this - # field will be populated with the data source stream ID that created the data - # point originally. + # If the data point is contained in a dataset for a derived data source, + # this field will be populated with the data source stream ID that created + # the data point originally. # WARNING: do not rely on this field for anything other than debugging. The - # value of this field, if it is set at all, is an implementation detail and is - # not guaranteed to remain consistent. + # value of this field, if it is set at all, is an implementation detail and + # is not guaranteed to remain consistent. # Corresponds to the JSON property `originDataSourceId` # @return [String] attr_accessor :origin_data_source_id @@ -402,17 +409,17 @@ module Google # @return [Fixnum] attr_accessor :raw_timestamp_nanos - # The start time of the interval represented by this data point, in nanoseconds - # since epoch. + # The start time of the interval represented by this data point, in + # nanoseconds since epoch. # Corresponds to the JSON property `startTimeNanos` # @return [Fixnum] attr_accessor :start_time_nanos # Values of each data type field for the data point. It is expected that each - # value corresponding to a data type field will occur in the same order that the - # field is listed with in the data type specified in a data source. - # Only one of integer and floating point fields will be populated, depending on - # the format enum value within data source's type field. + # value corresponding to a data type field will occur in the same order that + # the field is listed with in the data type specified in a data source. + # Only one of integer and floating point fields will be populated, depending + # on the format enum value within data source's type field. # Corresponds to the JSON property `value` # @return [Array] attr_accessor :value @@ -434,11 +441,12 @@ module Google end end - # Definition of a unique source of sensor data. Data sources can expose raw data - # coming from hardware sensors on local or companion devices. They can also - # expose derived data, created by transforming or merging other data sources. - # Multiple data sources can exist for the same data type. Every data point - # inserted into or read from this service has an associated data source. + # Definition of a unique source of sensor data. Data sources can expose raw + # data coming from hardware sensors on local or companion devices. They can + # also expose derived data, created by transforming or merging other data + # sources. Multiple data sources can exist for the same data type. Every data + # point inserted into or read from this service has an associated data + # source. # The data source contains enough information to uniquely identify its data, # including the hardware device and the application that collected and/or # transformed the data. It also holds useful metadata, such as the hardware and @@ -450,7 +458,7 @@ module Google class DataSource include Google::Apis::Core::Hashable - # + # Information about an application which feeds sensor data into the platform. # Corresponds to the JSON property `application` # @return [Google::Apis::FitnessV1::Application] attr_accessor :application @@ -463,46 +471,53 @@ module Google attr_accessor :data_quality_standard # A unique identifier for the data stream produced by this data source. The - # identifier includes: - # - # - The physical device's manufacturer, model, and serial number (UID). - # - The application's package name or name. Package name is used when the data - # source was created by an Android application. The developer project number is - # used when the data source was created by a REST client. - # - The data source's type. - # - The data source's stream name. Note that not all attributes of the data - # source are used as part of the stream identifier. In particular, the version - # of the hardware/the application isn't used. This allows us to preserve the - # same stream through version updates. This also means that two DataSource - # objects may represent the same data stream even if they're not equal. - # The exact format of the data stream ID created by an Android application is: - # type:dataType.name:application.packageName:device.manufacturer:device.model: - # device.uid:dataStreamName - # The exact format of the data stream ID created by a REST client is: type: - # dataType.name:developer project number:device.manufacturer:device.model:device. - # uid:dataStreamName + # identifier includes:

+ #
    + #
  • The physical device's manufacturer, model, and serial number + # (UID).
    • + #
  • The application's package name or name. Package name is used when the + # data source was created by an Android application. The developer project + # number is used when the data source was created by a REST client.
    • + #
  • The data source's type.
    • + #
  • The data source's stream name.
    • + #
+ # Note that not all attributes of the data source are used as part of the + # stream identifier. In particular, the version of the hardware/the + # application isn't used. This allows us to preserve the same stream through + # version updates. This also means that two DataSource objects may represent + # the same data stream even if they're not equal. + # The exact format of the data stream ID created by an Android application + # is: + # type:dataType.name:application.packageName:device. + # manufacturer:device.model:device.uid:dataStreamName + # The exact format of the data stream ID created by a REST client is: + # type:dataType.name:developer project + # number:device.manufacturer:device.model:device.uid: + # dataStreamName # When any of the optional fields that make up the data stream ID are absent, - # they will be omitted from the data stream ID. The minimum viable data stream - # ID would be: type:dataType.name:developer project number - # Finally, the developer project number and device UID are obfuscated when read - # by any REST or Android client that did not create the data source. Only the - # data source creator will see the developer project number in clear and normal - # form. This means a client will see a different set of data_stream_ids than - # another client with different credentials. + # they will be omitted from the data stream ID. The minimum viable data + # stream ID would be: + # type:dataType.name:developer project number + # Finally, the developer project number and device UID are obfuscated when + # read by any REST or Android client that did not create the data source. + # Only the data source creator will see the developer project number in clear + # and normal form. This means a client will see a different set of + # data_stream_ids than another client with different credentials. # Corresponds to the JSON property `dataStreamId` # @return [String] attr_accessor :data_stream_id - # The stream name uniquely identifies this particular data source among other - # data sources of the same type from the same underlying producer. Setting the - # stream name is optional, but should be done whenever an application exposes - # two streams for the same data type, or when a device has two equivalent - # sensors. + # The stream name uniquely identifies this particular data source among + # other data sources of the same type from the same underlying producer. + # Setting the stream name is optional, but should be done whenever an + # application exposes two streams for the same data type, or when a device + # has two equivalent sensors. # Corresponds to the JSON property `dataStreamName` # @return [String] attr_accessor :data_stream_name - # + # The data type defines the schema for a stream of data being collected by, + # inserted into, or queried from the Fitness API. # Corresponds to the JSON property `dataType` # @return [Google::Apis::FitnessV1::DataType] attr_accessor :data_type @@ -510,14 +525,17 @@ module Google # Representation of an integrated device (such as a phone or a wearable) that # can hold sensors. Each sensor is exposed as a data source. # The main purpose of the device information contained in this class is to - # identify the hardware of a particular data source. This can be useful in + # identify the hardware of a particular data source. This can be useful in # different ways, including: - # - Distinguishing two similar sensors on different devices (the step counter on - # two nexus 5 phones, for instance) - # - Display the source of data to the user (by using the device make / model) - # - Treat data differently depending on sensor type (accelerometers on a watch - # may give different patterns than those on a phone) - # - Build different analysis models for each device/version. + #
    + #
  • Distinguishing two similar sensors on different devices (the step + # counter on two nexus 5 phones, for instance) + #
  • Display the source of data to the user (by using the device make / + # model) + #
  • Treat data differently depending on sensor type (accelerometers on a + # watch may give different patterns than those on a phone) + #
  • Build different analysis models for each device/version. + #
# Corresponds to the JSON property `device` # @return [Google::Apis::FitnessV1::Device] attr_accessor :device @@ -559,8 +577,8 @@ module Google # @return [Array] attr_accessor :field - # Each data type has a unique, namespaced, name. All data types in the com. - # google namespace are shared as part of the platform. + # Each data type has a unique, namespaced, name. All data types in the + # com.google namespace are shared as part of the platform. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -590,8 +608,8 @@ module Google # @return [String] attr_accessor :format - # Defines the name and format of data. Unlike data type names, field names are - # not namespaced, and only need to be unique within the data type. + # Defines the name and format of data. Unlike data type names, field names + # are not namespaced, and only need to be unique within the data type. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -614,43 +632,44 @@ module Google end end - # A dataset represents a projection container for data points. They do not carry - # any info of their own. Datasets represent a set of data points from a + # A dataset represents a projection container for data points. They do not + # carry any info of their own. Datasets represent a set of data points from a # particular data source. A data point can be found in more than one dataset. class Dataset include Google::Apis::Core::Hashable - # The data stream ID of the data source that created the points in this dataset. + # The data stream ID of the data source that created the points in this + # dataset. # Corresponds to the JSON property `dataSourceId` # @return [String] attr_accessor :data_source_id # The largest end time of all data points in this possibly partial - # representation of the dataset. Time is in nanoseconds from epoch. This should - # also match the second part of the dataset identifier. + # representation of the dataset. Time is in nanoseconds from epoch. This + # should also match the second part of the dataset identifier. # Corresponds to the JSON property `maxEndTimeNs` # @return [Fixnum] attr_accessor :max_end_time_ns # The smallest start time of all data points in this possibly partial - # representation of the dataset. Time is in nanoseconds from epoch. This should - # also match the first part of the dataset identifier. + # representation of the dataset. Time is in nanoseconds from epoch. This + # should also match the first part of the dataset identifier. # Corresponds to the JSON property `minStartTimeNs` # @return [Fixnum] attr_accessor :min_start_time_ns - # This token will be set when a dataset is received in response to a GET request - # and the dataset is too large to be included in a single response. Provide this - # value in a subsequent GET request to return the next page of data points - # within this dataset. + # This token will be set when a dataset is received in response to a GET + # request and the dataset is too large to be included in a single response. + # Provide this value in a subsequent GET request to return the next page of + # data points within this dataset. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # A partial list of data points contained in the dataset, ordered by largest - # endTimeNanos first. This list is considered complete when retrieving a small - # dataset and partial when patching a dataset or retrieving a dataset that is - # too large to include in a single response. + # endTimeNanos first. This list is considered complete when retrieving a + # small dataset and partial when patching a dataset or retrieving a dataset + # that is too large to include in a single response. # Corresponds to the JSON property `point` # @return [Array] attr_accessor :point @@ -672,14 +691,17 @@ module Google # Representation of an integrated device (such as a phone or a wearable) that # can hold sensors. Each sensor is exposed as a data source. # The main purpose of the device information contained in this class is to - # identify the hardware of a particular data source. This can be useful in + # identify the hardware of a particular data source. This can be useful in # different ways, including: - # - Distinguishing two similar sensors on different devices (the step counter on - # two nexus 5 phones, for instance) - # - Display the source of data to the user (by using the device make / model) - # - Treat data differently depending on sensor type (accelerometers on a watch - # may give different patterns than those on a phone) - # - Build different analysis models for each device/version. + #
    + #
  • Distinguishing two similar sensors on different devices (the step + # counter on two nexus 5 phones, for instance) + #
  • Display the source of data to the user (by using the device make / + # model) + #
  • Treat data differently depending on sensor type (accelerometers on a + # watch may give different patterns than those on a phone) + #
  • Build different analysis models for each device/version. + #
class Device include Google::Apis::Core::Hashable @@ -699,9 +721,9 @@ module Google attr_accessor :type # The serial number or other unique ID for the hardware. This field is - # obfuscated when read by any REST or Android client that did not create the - # data source. Only the data source creator will see the uid field in clear and - # normal form. + # obfuscated when read by any REST or Android client that did not create + # the data source. Only the data source creator will see the uid field in + # clear and normal form. # The obfuscation preserves equality; that is, given two IDs, if id1 == id2, # obfuscated(id1) == obfuscated(id2). # Corresponds to the JSON property `uid` @@ -748,7 +770,8 @@ module Google attr_accessor :inserted_data_point # The continuation token, which is used to page through large result sets. - # Provide this value in a subsequent request to return the next page of results. + # Provide this value in a subsequent request to return the next page of + # results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -789,26 +812,29 @@ module Google class ListSessionsResponse include Google::Apis::Core::Hashable - # If includeDeleted is set to true in the request, this list will contain - # sessions deleted with original end times that are within the startTime and - # endTime frame. + # If includeDeleted is set to true in the request, and + # startTime and endTime are omitted, this will include + # sessions which were deleted since the last sync. # Corresponds to the JSON property `deletedSession` # @return [Array] attr_accessor :deleted_session - # Flag to indicate server has more data to transfer + # Flag to indicate server has more data to transfer. + # DO NOT USE THIS FIELD. It is never populated in responses from the server. # Corresponds to the JSON property `hasMoreData` # @return [Boolean] attr_accessor :has_more_data alias_method :has_more_data?, :has_more_data - # The continuation token, which is used to page through large result sets. - # Provide this value in a subsequent request to return the next page of results. + # The sync token which is used to sync further changes. This will only be + # provided if both startTime and endTime are omitted + # from the request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # Sessions with an end time that is between startTime and endTime of the request. + # Sessions with an end time that is between startTime and + # endTime of the request. # Corresponds to the JSON property `session` # @return [Array] attr_accessor :session @@ -851,11 +877,12 @@ module Google class Session include Google::Apis::Core::Hashable - # Session active time. While start_time_millis and end_time_millis define the - # full session time, the active time can be shorter and specified by - # active_time_millis. If the inactive time during the session is known, it - # should also be inserted via a com.google.activity.segment data point with a - # STILL activity value + # Session active time. While start_time_millis and end_time_millis define + # the full session time, the active time can be shorter and specified by + # active_time_millis. + # If the inactive time during the session is known, it should also be + # inserted via a com.google.activity.segment data point with a STILL + # activity value # Corresponds to the JSON property `activeTimeMillis` # @return [Fixnum] attr_accessor :active_time_millis @@ -865,7 +892,7 @@ module Google # @return [Fixnum] attr_accessor :activity_type - # + # The application that created the session. # Corresponds to the JSON property `application` # @return [Google::Apis::FitnessV1::Application] attr_accessor :application @@ -880,8 +907,8 @@ module Google # @return [Fixnum] attr_accessor :end_time_millis - # A client-generated identifier that is unique across all sessions owned by this - # particular user. + # A client-generated identifier that is unique across all sessions owned by + # this particular user. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -935,17 +962,17 @@ module Google # @return [Fixnum] attr_accessor :int_val - # Map value. The valid key space and units for the corresponding value of each - # entry should be documented as part of the data type definition. Keys should be - # kept small whenever possible. Data streams with large keys and high data - # frequency may be down sampled. + # Map value. The valid key space and units for the corresponding value + # of each entry should be documented as part of the data type definition. + # Keys should be kept small whenever possible. Data streams with large keys + # and high data frequency may be down sampled. # Corresponds to the JSON property `mapVal` # @return [Array] attr_accessor :map_val - # String value. When this is set, other values must not be set. Strings should - # be kept small whenever possible. Data streams with large string values and - # high data frequency may be down sampled. + # String value. When this is set, other values must not be set. + # Strings should be kept small whenever possible. Data streams with large + # string values and high data frequency may be down sampled. # Corresponds to the JSON property `stringVal` # @return [String] attr_accessor :string_val diff --git a/generated/google/apis/fitness_v1/service.rb b/generated/google/apis/fitness_v1/service.rb index 3e4b856ea..148faa4ae 100644 --- a/generated/google/apis/fitness_v1/service.rb +++ b/generated/google/apis/fitness_v1/service.rb @@ -20,9 +20,9 @@ require 'google/apis/errors' module Google module Apis module FitnessV1 - # Fitness + # Fitness API # - # Stores and accesses user data in the fitness store from apps on any platform. + # The Fitness API for managing users' fitness tracking data. # # @example # require 'google/apis/fitness_v1' @@ -30,7 +30,7 @@ module Google # Fitness = Google::Apis::FitnessV1 # Alias the module # service = Fitness::FitnessService.new # - # @see https://developers.google.com/fit/rest/ + # @see https://developers.google.com/fit/rest/v1/get-started class FitnessService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -38,57 +38,55 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'fitness/v1/users/') + super('https://www.googleapis.com/', '') @batch_path = 'batch/fitness/v1' end - # Creates a new data source that is unique across all data sources belonging to - # this user. - # A data source is a unique source of sensor data. Data sources can expose raw - # data coming from hardware sensors on local or companion devices. They can also - # expose derived data, created by transforming or merging other data sources. - # Multiple data sources can exist for the same data type. Every data point in - # every dataset inserted into or read from the Fitness API has an associated - # data source. - # Each data source produces a unique stream of dataset updates, with a unique - # data source identifier. Not all changes to data source affect the data stream - # ID, so that data collected by updated versions of the same application/device - # can still be considered to belong to the same data source. - # Data sources are identified using a string generated by the server, based on - # the contents of the source being created. The dataStreamId field should not be - # set when invoking this method. It will be automatically generated by the - # server with the correct format. If a dataStreamId is set, it must match the - # format that the server would generate. This format is a combination of some - # fields from the data source, and has a specific order. If it doesn't match, - # the request will fail with an error. - # Specifying a DataType which is not a known type (beginning with "com.google.") - # will create a DataSource with a custom data type. Custom data types are only - # readable by the application that created them. Custom data types are - # deprecated; use standard data types instead. + # Creates a new data source that is unique across all data sources belonging + # to this user. + # A data source is a unique source of sensor data. Data sources can expose + # raw data coming from hardware sensors on local or companion devices. They + # can also expose derived data, created by transforming or merging other data + # sources. Multiple data sources can exist for the same data type. Every data + # point in every dataset inserted into or read from the Fitness API has an + # associated data source. + # Each data source produces a unique stream of dataset updates, with a + # unique data source identifier. Not all changes to data source affect the + # data stream ID, so that data collected by updated versions of the same + # application/device can still be considered to belong to the same data + # source. + # Data sources are identified using a string generated by the server, based + # on the contents of the source being created. The dataStreamId + # field should not be set when invoking this method. It + # will be automatically generated by the server with the correct format. If + # a dataStreamId is set, it must match the format that the + # server would generate. This format is a combination of some fields from the + # data source, and has a specific order. If it doesn't match, the request + # will fail with an error. + # Specifying a DataType which is not a known type (beginning with + # "com.google.") will create a DataSource with a custom data type. + # Custom data types are only readable by the application that created them. + # Custom data types are deprecated; use standard data types + # instead. # In addition to the data source fields included in the data source ID, the - # developer project number that is authenticated when creating the data source - # is included. This developer project number is obfuscated when read by any - # other developer reading public data types. + # developer project number that is authenticated when creating the data + # source is included. This developer project number is obfuscated when read + # by any other developer reading public data types. # @param [String] user_id - # Create the data source for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # Create the data source for the person identified. Use me to + # indicate the authenticated user. Only me is supported at this + # time. # @param [Google::Apis::FitnessV1::DataSource] data_source_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -101,8 +99,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_user_data_source(user_id, data_source_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/dataSources', options) + def create_user_data_source(user_id, data_source_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'fitness/v1/users/{userId}/dataSources', options) command.request_representation = Google::Apis::FitnessV1::DataSource::Representation command.request_object = data_source_object command.response_representation = Google::Apis::FitnessV1::DataSource::Representation @@ -110,24 +108,22 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Deletes the specified data source. The request will fail if the data source - # contains any data points. + # Deletes the specified data source. The request will fail if the data + # source contains any data points. # @param [String] user_id - # Retrieve a data source for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # Retrieve a data source for the person identified. Use me to + # indicate the authenticated user. Only me is supported at this + # time. # @param [String] data_source_id # The data stream ID of the data source to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -140,31 +136,29 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_data_source(user_id, data_source_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/dataSources/{dataSourceId}', options) + def delete_user_data_source(user_id, data_source_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'fitness/v1/users/{userId}/dataSources/{dataSourceId}', options) command.response_representation = Google::Apis::FitnessV1::DataSource::Representation command.response_class = Google::Apis::FitnessV1::DataSource command.params['userId'] = user_id unless user_id.nil? command.params['dataSourceId'] = data_source_id unless data_source_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Returns the specified data source. # @param [String] user_id - # Retrieve a data source for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # Retrieve a data source for the person identified. Use me to + # indicate the authenticated user. Only me is supported at this + # time. # @param [String] data_source_id # The data stream ID of the data source to retrieve. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -177,34 +171,33 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_data_source(user_id, data_source_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/dataSources/{dataSourceId}', options) + def get_user_data_source(user_id, data_source_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'fitness/v1/users/{userId}/dataSources/{dataSourceId}', options) command.response_representation = Google::Apis::FitnessV1::DataSource::Representation command.response_class = Google::Apis::FitnessV1::DataSource command.params['userId'] = user_id unless user_id.nil? command.params['dataSourceId'] = data_source_id unless data_source_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists all data sources that are visible to the developer, using the OAuth - # scopes provided. The list is not exhaustive; the user may have private data - # sources that are only visible to other developers, or calls using other scopes. + # scopes provided. The list is not exhaustive; the user may have private + # data sources that are only visible to other developers, or calls using + # other scopes. # @param [String] user_id - # List data sources for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # List data sources for the person identified. Use me to + # indicate the authenticated user. Only me is supported at this + # time. # @param [Array, String] data_type_name - # The names of data types to include in the list. If not specified, all data - # sources will be returned. + # The names of data types to include in the list. If not specified, all + # data sources will be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -217,35 +210,34 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_data_sources(user_id, data_type_name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/dataSources', options) + def list_user_data_sources(user_id, data_type_name: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'fitness/v1/users/{userId}/dataSources', options) command.response_representation = Google::Apis::FitnessV1::ListDataSourcesResponse::Representation command.response_class = Google::Apis::FitnessV1::ListDataSourcesResponse command.params['userId'] = user_id unless user_id.nil? command.query['dataTypeName'] = data_type_name unless data_type_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates the specified data source. The dataStreamId, dataType, type, - # dataStreamName, and device properties with the exception of version, cannot be - # modified. - # Data sources are identified by their dataStreamId. + # Updates the specified data source. The dataStreamId, + # dataType, type, dataStreamName, and + # device properties with the exception of version, + # cannot be modified. + # Data sources are identified by their dataStreamId. # @param [String] user_id - # Update the data source for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # Update the data source for the person identified. Use me to + # indicate the authenticated user. Only me is supported at this + # time. # @param [String] data_source_id # The data stream ID of the data source to update. # @param [Google::Apis::FitnessV1::DataSource] data_source_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -258,8 +250,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_data_source(user_id, data_source_id, data_source_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{userId}/dataSources/{dataSourceId}', options) + def update_user_data_source(user_id, data_source_id, data_source_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'fitness/v1/users/{userId}/dataSources/{dataSourceId}', options) command.request_representation = Google::Apis::FitnessV1::DataSource::Representation command.request_object = data_source_object command.response_representation = Google::Apis::FitnessV1::DataSource::Representation @@ -268,30 +260,27 @@ module Google command.params['dataSourceId'] = data_source_id unless data_source_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Queries for user's data point changes for a particular data source. # @param [String] user_id - # List data points for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # List data points for the person identified. Use me to indicate + # the authenticated user. Only me is supported at this time. # @param [String] data_source_id # The data stream ID of the data source that created the dataset. # @param [Fixnum] limit - # If specified, no more than this many data point changes will be included in - # the response. + # If specified, no more than this many data point changes will be included + # in the response. # @param [String] page_token - # The continuation token, which is used to page through large result sets. To - # get the next page of results, set this parameter to the value of nextPageToken - # from the previous response. + # The continuation token, which is used to page through large result sets. + # To get the next page of results, set this parameter to the value of + # nextPageToken from the previous response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -304,8 +293,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_data_source_data_point_changes(user_id, data_source_id, limit: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/dataSources/{dataSourceId}/dataPointChanges', options) + def list_user_data_source_data_point_changes(user_id, data_source_id, limit: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'fitness/v1/users/{userId}/dataSources/{dataSourceId}/dataPointChanges', options) command.response_representation = Google::Apis::FitnessV1::ListDataPointChangesResponse::Representation command.response_class = Google::Apis::FitnessV1::ListDataPointChangesResponse command.params['userId'] = user_id unless user_id.nil? @@ -314,26 +303,26 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Performs an inclusive delete of all data points whose start and end times have - # any overlap with the time range specified by the dataset ID. For most data - # types, the entire data point will be deleted. For data types where the time - # span represents a consistent value (such as com.google.activity.segment), and - # a data point straddles either end point of the dataset, only the overlapping - # portion of the data point will be deleted. + # Performs an inclusive delete of all data points whose start and end times + # have any overlap with the time range specified by the dataset ID. For most + # data types, the entire data point will be deleted. For data types where the + # time span represents a consistent value (such as + # com.google.activity.segment), and a data point straddles + # either end point of the dataset, only the overlapping portion of the data + # point will be deleted. # @param [String] user_id - # Delete a dataset for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # Delete a dataset for the person identified. Use me to indicate + # the authenticated user. Only me is supported at this time. # @param [String] data_source_id # The data stream ID of the data source that created the dataset. # @param [String] dataset_id # Dataset identifier that is a composite of the minimum data point start time - # and maximum data point end time represented as nanoseconds from the epoch. The - # ID is formatted like: "startTime-endTime" where startTime and endTime are 64 - # bit integers. + # and maximum data point end time represented as nanoseconds from the epoch. + # The ID is formatted like: "startTime-endTime" + # where startTime and endTime are 64 bit integers. # @param [Fixnum] current_time_millis # The client's current time in milliseconds since epoch. # @param [Fixnum] modified_time_millis @@ -341,10 +330,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -357,8 +344,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_data_source_dataset(user_id, data_source_id, dataset_id, current_time_millis: nil, modified_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/dataSources/{dataSourceId}/datasets/{datasetId}', options) + def delete_user_data_source_dataset(user_id, data_source_id, dataset_id, current_time_millis: nil, modified_time_millis: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'fitness/v1/users/{userId}/dataSources/{dataSourceId}/datasets/{datasetId}', options) command.params['userId'] = user_id unless user_id.nil? command.params['dataSourceId'] = data_source_id unless data_source_id.nil? command.params['datasetId'] = dataset_id unless dataset_id.nil? @@ -366,42 +353,40 @@ module Google command.query['modifiedTimeMillis'] = modified_time_millis unless modified_time_millis.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Returns a dataset containing all data points whose start and end times overlap - # with the specified range of the dataset minimum start time and maximum end - # time. Specifically, any data point whose start time is less than or equal to - # the dataset end time and whose end time is greater than or equal to the - # dataset start time. + # Returns a dataset containing all data points whose start and end times + # overlap with the specified range of the dataset minimum start time and + # maximum end time. Specifically, any data point whose start time is less + # than or equal to the dataset end time and whose end time is greater than or + # equal to the dataset start time. # @param [String] user_id - # Retrieve a dataset for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # Retrieve a dataset for the person identified. Use me to + # indicate the authenticated user. Only me is supported at this + # time. # @param [String] data_source_id # The data stream ID of the data source that created the dataset. # @param [String] dataset_id # Dataset identifier that is a composite of the minimum data point start time - # and maximum data point end time represented as nanoseconds from the epoch. The - # ID is formatted like: "startTime-endTime" where startTime and endTime are 64 - # bit integers. + # and maximum data point end time represented as nanoseconds from the epoch. + # The ID is formatted like: "startTime-endTime" + # where startTime and endTime are 64 bit integers. # @param [Fixnum] limit # If specified, no more than this many data points will be included in the - # dataset. If there are more data points in the dataset, nextPageToken will be - # set in the dataset response. + # dataset. If there are more data points in the dataset, nextPageToken + # will be set in the dataset response. # @param [String] page_token - # The continuation token, which is used to page through large datasets. To get - # the next page of a dataset, set this parameter to the value of nextPageToken - # from the previous response. Each subsequent call will yield a partial dataset - # with data point end timestamps that are strictly smaller than those in the - # previous partial response. + # The continuation token, which is used to page through large datasets. + # To get the next page of a dataset, set this parameter to the value of + # nextPageToken from the previous response. Each subsequent + # call will yield a partial dataset with data point end timestamps that are + # strictly smaller than those in the previous partial response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -414,8 +399,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_data_source_dataset(user_id, data_source_id, dataset_id, limit: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/dataSources/{dataSourceId}/datasets/{datasetId}', options) + def get_user_data_source_dataset(user_id, data_source_id, dataset_id, limit: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'fitness/v1/users/{userId}/dataSources/{dataSourceId}/datasets/{datasetId}', options) command.response_representation = Google::Apis::FitnessV1::Dataset::Representation command.response_class = Google::Apis::FitnessV1::Dataset command.params['userId'] = user_id unless user_id.nil? @@ -425,36 +410,33 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Adds data points to a dataset. The dataset need not be previously created. All - # points within the given dataset will be returned with subsquent calls to - # retrieve this dataset. Data points can belong to more than one dataset. This - # method does not use patch semantics. + # Adds data points to a dataset. The dataset need not be previously created. + # All points within the given dataset will be returned with subsquent calls + # to retrieve this dataset. Data points can belong to more than one dataset. + # This method does not use patch semantics. # @param [String] user_id - # Patch a dataset for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # Patch a dataset for the person identified. Use me to indicate + # the authenticated user. Only me is supported at this time. # @param [String] data_source_id # The data stream ID of the data source that created the dataset. # @param [String] dataset_id # Dataset identifier that is a composite of the minimum data point start time - # and maximum data point end time represented as nanoseconds from the epoch. The - # ID is formatted like: "startTime-endTime" where startTime and endTime are 64 - # bit integers. + # and maximum data point end time represented as nanoseconds from the epoch. + # The ID is formatted like: "startTime-endTime" + # where startTime and endTime are 64 bit integers. # @param [Google::Apis::FitnessV1::Dataset] dataset_object # @param [Fixnum] current_time_millis # The client's current time in milliseconds since epoch. Note that the - # minStartTimeNs and maxEndTimeNs properties in the request body are in - # nanoseconds instead of milliseconds. + # minStartTimeNs and maxEndTimeNs properties in + # the request body are in nanoseconds instead of milliseconds. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -467,8 +449,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_user_data_source_dataset(user_id, data_source_id, dataset_id, dataset_object = nil, current_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{userId}/dataSources/{dataSourceId}/datasets/{datasetId}', options) + def patch_user_data_source_dataset(user_id, data_source_id, dataset_id, dataset_object = nil, current_time_millis: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'fitness/v1/users/{userId}/dataSources/{dataSourceId}/datasets/{datasetId}', options) command.request_representation = Google::Apis::FitnessV1::Dataset::Representation command.request_object = dataset_object command.response_representation = Google::Apis::FitnessV1::Dataset::Representation @@ -479,7 +461,6 @@ module Google command.query['currentTimeMillis'] = current_time_millis unless current_time_millis.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -487,16 +468,14 @@ module Google # type of boundary. Multiple data sets of multiple types and from multiple # sources can be aggregated into exactly one bucket type per request. # @param [String] user_id - # Aggregate data for the person identified. Use me to indicate the authenticated - # user. Only me is supported at this time. + # Aggregate data for the person identified. Use me to indicate + # the authenticated user. Only me is supported at this time. # @param [Google::Apis::FitnessV1::AggregateRequest] aggregate_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -509,8 +488,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregate_dataset(user_id, aggregate_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/dataset:aggregate', options) + def aggregate_dataset(user_id, aggregate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'fitness/v1/users/{userId}/dataset:aggregate', options) command.request_representation = Google::Apis::FitnessV1::AggregateRequest::Representation command.request_object = aggregate_request_object command.response_representation = Google::Apis::FitnessV1::AggregateResponse::Representation @@ -518,14 +497,13 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes a session specified by the given session ID. # @param [String] user_id - # Delete a session for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # Delete a session for the person identified. Use me to indicate + # the authenticated user. Only me is supported at this time. # @param [String] session_id # The ID of the session to be deleted. # @param [Fixnum] current_time_millis @@ -533,10 +511,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -549,48 +525,49 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_session(user_id, session_id, current_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/sessions/{sessionId}', options) + def delete_user_session(user_id, session_id, current_time_millis: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'fitness/v1/users/{userId}/sessions/{sessionId}', options) command.params['userId'] = user_id unless user_id.nil? command.params['sessionId'] = session_id unless session_id.nil? command.query['currentTimeMillis'] = current_time_millis unless current_time_millis.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists sessions previously created. # @param [String] user_id - # List sessions for the person identified. Use me to indicate the authenticated - # user. Only me is supported at this time. + # List sessions for the person identified. Use me to indicate + # the authenticated user. Only me is supported at this time. # @param [Array, Fixnum] activity_type # If non-empty, only sessions with these activity types should be returned. # @param [String] end_time - # An RFC3339 timestamp. Only sessions ending between the start and end times - # will be included in the response. + # An RFC3339 timestamp. + # Only sessions ending between the start and end times will be included in + # the response. If this time is omitted but startTime is + # specified, all sessions from startTime to the end of time will + # be returned. # @param [Boolean] include_deleted - # If true, deleted sessions will be returned. When set to true, sessions - # returned in this response will only have an ID and will not have any other - # fields. + # If true, and if both startTime and endTime are + # omitted, session deletions will be returned. # @param [String] page_token - # The continuation token, which is used for incremental syncing. To get the next - # batch of changes, set this parameter to the value of nextPageToken from the - # previous response. This token is treated as a timestamp (in millis since epoch) - # . If specified, the API returns sessions modified since this time. The page - # token is ignored if either start or end time is specified. If none of start - # time, end time, and the page token is specified, sessions modified in the last + # The continuation token, which is used for incremental syncing. + # To get the next batch of changes, set this parameter to the value of + # nextPageToken from the previous response. The page token is + # ignored if either start or end time is specified. If none of start time, + # end time, and the page token is specified, sessions modified in the last # 30 days are returned. # @param [String] start_time - # An RFC3339 timestamp. Only sessions ending between the start and end times - # will be included in the response. + # An RFC3339 timestamp. + # Only sessions ending between the start and end times will be included in + # the response. If this time is omitted but endTime is specified, + # all sessions from the start of time up to endTime will be + # returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -603,8 +580,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_sessions(user_id, activity_type: nil, end_time: nil, include_deleted: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/sessions', options) + def list_user_sessions(user_id, activity_type: nil, end_time: nil, include_deleted: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'fitness/v1/users/{userId}/sessions', options) command.response_representation = Google::Apis::FitnessV1::ListSessionsResponse::Representation command.response_class = Google::Apis::FitnessV1::ListSessionsResponse command.params['userId'] = user_id unless user_id.nil? @@ -615,14 +592,13 @@ module Google command.query['startTime'] = start_time unless start_time.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates or insert a given session. # @param [String] user_id - # Create sessions for the person identified. Use me to indicate the - # authenticated user. Only me is supported at this time. + # Create sessions for the person identified. Use me to indicate + # the authenticated user. Only me is supported at this time. # @param [String] session_id # The ID of the session to be created. # @param [Google::Apis::FitnessV1::Session] session_object @@ -631,10 +607,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -647,8 +621,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_session(user_id, session_id, session_object = nil, current_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{userId}/sessions/{sessionId}', options) + def update_user_session(user_id, session_id, session_object = nil, current_time_millis: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'fitness/v1/users/{userId}/sessions/{sessionId}', options) command.request_representation = Google::Apis::FitnessV1::Session::Representation command.request_object = session_object command.response_representation = Google::Apis::FitnessV1::Session::Representation @@ -658,7 +632,6 @@ module Google command.query['currentTimeMillis'] = current_time_millis unless current_time_millis.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -667,7 +640,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/healthcare_v1.rb b/generated/google/apis/healthcare_v1.rb index 7b1b3e380..7aa5c29c4 100644 --- a/generated/google/apis/healthcare_v1.rb +++ b/generated/google/apis/healthcare_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1 VERSION = 'V1' - REVISION = '20200501' + REVISION = '20200515' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1/classes.rb b/generated/google/apis/healthcare_v1/classes.rb index e6d2f4546..14ca90c8f 100644 --- a/generated/google/apis/healthcare_v1/classes.rb +++ b/generated/google/apis/healthcare_v1/classes.rb @@ -258,8 +258,9 @@ module Google include Google::Apis::Core::Hashable # A complete HL7v2 message. - # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details - # on the standard. + # See [Introduction to HL7 Standards] + # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for + # details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1::Message] attr_accessor :message @@ -729,9 +730,9 @@ module Google end # Response when all resources export successfully. - # This structure will be included in the + # This structure is included in the # response to describe the detailed - # outcome. It will only be included when the operation finishes successfully. + # outcome after the operation finishes successfully. class ExportResourcesResponse include Google::Apis::Core::Hashable @@ -977,6 +978,8 @@ module Google # Supported types are: AdministrativeGenderCode, Code, Date, DateTime, # Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, # Xhtml. + # Base64Binary is also supported, but may only be kept as-is or have all + # the content removed. # Corresponds to the JSON property `paths` # @return [Array] attr_accessor :paths @@ -1153,7 +1156,7 @@ module Google # @return [String] attr_accessor :dataset_uri - # If this flag is `TRUE`, all tables will be deleted from the dataset before + # If this flag is `TRUE`, all tables are deleted from the dataset before # the new exported tables are written. If the flag is not set and the # destination dataset contains tables, the export call returns an error. # Corresponds to the JSON property `force` @@ -1183,9 +1186,9 @@ module Google class GoogleCloudHealthcareV1FhirGcsDestination include Google::Apis::Core::Hashable - # URI for a Cloud Storage directory where result files should be written (in - # the format `gs://`bucket-id`/`path/to/destination/dir``). If there is no - # trailing slash, the service will append one when composing the object path. + # URI for a Cloud Storage directory where result files should be written, in + # the format of `gs://`bucket-id`/`path/to/destination/dir``. If there is no + # trailing slash, the service appends one when composing the object path. # The user is responsible for creating the Cloud Storage bucket referenced in # `uri_prefix`. # Corresponds to the JSON property `uriPrefix` @@ -1243,7 +1246,7 @@ module Google # Restricts notifications sent for messages matching a filter. If this is # empty, all messages are matched. Syntax: # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # Fields/functions available for filtering are: + # The following fields and functions are available for filtering: # * `message_type`, from the MSH-9.1 field. For example, # `NOT message_type = "ADT"`. # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in @@ -1267,21 +1270,24 @@ module Google attr_accessor :filter # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that - # notifications of changes are published on. Supplied by the client. The - # notification is a `PubsubMessage` with the following fields: + # notifications of changes are published on. Supplied by the client. + # The notification is a `PubsubMessage` with the following fields: # * `PubsubMessage.Data` contains the resource name. - # * `PubsubMessage.MessageId` is the ID of this notification. It is + # * `PubsubMessage.MessageId` is the ID of this notification. It's # guaranteed to be unique within the topic. - # * `PubsubMessage.PublishTime` is the time at which the message was + # * `PubsubMessage.PublishTime` is the time when the message was # published. # Note that notifications are only sent if the topic is non-empty. [Topic # names](https://cloud.google.com/pubsub/docs/overview#names) must be - # scoped to a project. Cloud Healthcare API service account must have + # scoped to a project. + # The Cloud Healthcare API service account, + # service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, + # must have # publisher permissions on the given Pub/Sub topic. Not having adequate # permissions causes the calls that send notifications to fail. - # If a notification cannot be published to Cloud Pub/Sub, errors will be - # logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how- - # tos/logging)). + # If a notification cannot be published to Cloud Pub/Sub, errors are + # logged to Cloud Logging. For more information, see + # [Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging)). # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic @@ -1334,7 +1340,7 @@ module Google # @return [Google::Apis::HealthcareV1::ParserConfig] attr_accessor :parser_config - # Determines whether duplicate messages should be rejected. A duplicate + # Determines whether to reject duplicate messages. A duplicate # message is a message with the same raw bytes as a message that has already # been ingested/created in this HL7v2 store. # The default value is false, meaning that the store accepts the duplicate @@ -1506,9 +1512,9 @@ module Google end # Final response of importing resources. - # This structure will be included in the + # This structure is included in the # response to describe the detailed - # outcome. It will only be included when the operation finishes successfully. + # outcome after the operation finishes successfully. class ImportResourcesResponse include Google::Apis::Core::Hashable @@ -1587,8 +1593,9 @@ module Google include Google::Apis::Core::Hashable # A complete HL7v2 message. - # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details - # on the standard. + # See [Introduction to HL7 Standards] + # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for + # details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1::Message] attr_accessor :message @@ -1615,8 +1622,9 @@ module Google attr_accessor :hl7_ack # A complete HL7v2 message. - # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details - # on the standard. + # See [Introduction to HL7 Standards] + # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for + # details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1::Message] attr_accessor :message @@ -1794,8 +1802,9 @@ module Google end # A complete HL7v2 message. - # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details - # on the standard. + # See [Introduction to HL7 Standards] + # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for + # details on the standard. class Message include Google::Apis::Core::Hashable @@ -2533,7 +2542,7 @@ module Google end end - # This structure contains configuration for streaming FHIR export. + # Contains configuration for streaming FHIR export. class StreamConfig include Google::Apis::Core::Hashable diff --git a/generated/google/apis/healthcare_v1/service.rb b/generated/google/apis/healthcare_v1/service.rb index a1eb3e844..c5ce94622 100644 --- a/generated/google/apis/healthcare_v1/service.rb +++ b/generated/google/apis/healthcare_v1/service.rb @@ -752,7 +752,9 @@ module Google end # SearchForInstances returns a list of matching instances. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [Search Transaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -790,7 +792,9 @@ module Google end # SearchForSeries returns a list of matching series. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [Search Transaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -827,7 +831,9 @@ module Google end # SearchForStudies returns a list of matching studies. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [Search Transaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -900,7 +906,9 @@ module Google # StoreInstances stores DICOM instances associated with study instance unique # identifiers (SUID). See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. + # [Store Transaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1015,7 +1023,9 @@ module Google # RetrieveStudyMetadata returns instance associated with the given study # presented as metadata with the bulk data removed. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1052,7 +1062,9 @@ module Google end # RetrieveStudy returns all instances within the given study. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1089,7 +1101,9 @@ module Google end # SearchForInstances returns a list of matching instances. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [Search Transaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1127,7 +1141,9 @@ module Google end # SearchForSeries returns a list of matching series. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [Search Transaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1165,7 +1181,9 @@ module Google # StoreInstances stores DICOM instances associated with study instance unique # identifiers (SUID). See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. + # [Store Transaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1246,7 +1264,9 @@ module Google # RetrieveSeriesMetadata returns instance associated with the given study and # series, presented as metadata with the bulk data removed. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1283,7 +1303,9 @@ module Google end # RetrieveSeries returns all instances within the given study and series. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1320,7 +1342,9 @@ module Google end # SearchForInstances returns a list of matching instances. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [Search Transaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1397,7 +1421,9 @@ module Google # RetrieveInstance returns instance associated with the given study, series, # and SOP Instance UID. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1436,7 +1462,9 @@ module Google # RetrieveInstanceMetadata returns instance associated with the given study, # series, and SOP Instance UID presented as metadata with the bulk data # removed. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1474,7 +1502,9 @@ module Google # RetrieveRenderedInstance returns instance associated with the given study, # series, and SOP Instance UID in an acceptable Rendered Media Type. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1512,7 +1542,9 @@ module Google # RetrieveFrames returns instances associated with the given study, series, # SOP Instance UID and frame numbers. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4` + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1552,7 +1584,9 @@ module Google # RetrieveRenderedFrames returns instances associated with the given study, # series, SOP Instance UID and frame numbers in an acceptable Rendered Media # Type. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction] + # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4) + # . # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1713,8 +1747,7 @@ module Google # The metadata field type for this # operation is OperationMetadata. # @param [String] name - # The name of the FHIR store to export resource from. The name should be in - # the format of + # The name of the FHIR store to export resource from, in the format of # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ # fhirStores/`fhir_store_id``. # @param [Google::Apis::HealthcareV1::ExportResourcesRequest] export_resources_request_object @@ -1821,15 +1854,15 @@ module Google execute_or_queue_command(command, &block) end - # Import resources to the FHIR store by loading data from the specified + # Imports resources to the FHIR store by loading data from the specified # sources. This method is optimized to load large quantities of data using # import semantics that ignore some FHIR store configuration options and are # not suitable for all use cases. It is primarily intended to load data into # an empty FHIR store that is not being used by other clients. In cases # where this method is not appropriate, consider using ExecuteBundle to # load data. - # Every resource in the input must contain a client-supplied ID, and will be - # stored using that ID regardless of the + # Every resource in the input must contain a client-supplied ID. Each + # resource is stored using the supplied ID regardless of the # enable_update_create setting on the FHIR # store. # The import process does not enforce referential integrity, regardless of @@ -1847,14 +1880,14 @@ module Google # version, regardless of the # disable_resource_versioning # setting on the FHIR store. If transient failures occur during the import, - # it is possible that successfully imported resources will be overwritten + # it's possible that successfully imported resources will be overwritten # more than once. # The import operation is idempotent unless the input data contains multiple # valid resources with the same ID but different contents. In that case, - # after the import completes, the store will contain exactly one resource + # after the import completes, the store contains exactly one resource # with that ID but there is no ordering guarantee on which version of the # contents it will have. The operation result counters do not count - # duplicate IDs as an error and will count one success for each resource in + # duplicate IDs as an error and count one success for each resource in # the input, which might result in a success count larger than the number # of resources in the FHIR store. This often occurs when importing data # organized in bundles produced by Patient-everything @@ -1886,8 +1919,7 @@ module Google # The metadata field type for this # operation is OperationMetadata. # @param [String] name - # The name of the FHIR store to import FHIR resources to. The name should be - # in the format of + # The name of the FHIR store to import FHIR resources to, in the format of # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ # fhirStores/`fhir_store_id``. # @param [Google::Apis::HealthcareV1::ImportResourcesRequest] import_resources_request_object @@ -2754,8 +2786,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified HL7v2 store and removes all messages that are - # contained within it. + # Deletes the specified HL7v2 store and removes all messages that it + # contains. # @param [String] name # The resource name of the HL7v2 store to delete. # @param [String] fields diff --git a/generated/google/apis/healthcare_v1beta1.rb b/generated/google/apis/healthcare_v1beta1.rb index d4c09be88..bccdb4c53 100644 --- a/generated/google/apis/healthcare_v1beta1.rb +++ b/generated/google/apis/healthcare_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1beta1 VERSION = 'V1beta1' - REVISION = '20200501' + REVISION = '20200515' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1beta1/classes.rb b/generated/google/apis/healthcare_v1beta1/classes.rb index 2bd5da144..861eac41d 100644 --- a/generated/google/apis/healthcare_v1beta1/classes.rb +++ b/generated/google/apis/healthcare_v1beta1/classes.rb @@ -258,8 +258,9 @@ module Google include Google::Apis::Core::Hashable # A complete HL7v2 message. - # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details - # on the standard. + # See [Introduction to HL7 Standards] + # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for + # details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1beta1::Message] attr_accessor :message @@ -276,8 +277,8 @@ module Google # Pseudonymization method that generates surrogates via cryptographic hashing. # Uses SHA-256. - # Outputs a base64-encoded representation of the hashed output - # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). + # Outputs a base64-encoded representation of the hashed output. + # For example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`. class CryptoHashConfig include Google::Apis::Core::Hashable @@ -1111,14 +1112,14 @@ module Google # can be matched by "Patient.Address.String". Path also supports partial # matching. For example, "Patient.Address.city" can be matched by # "Address.city" (Patient omitted). Partial matching and type matching - # can be combined, for example "Patient.Address.city" can be matched by + # can be combined. For example, "Patient.Address.city" can be matched by # "Address.String". For "choice" types (those defined in the FHIR spec # with the form: field[x]), use two separate components. For example, # "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types # are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, # HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. - # The sub-type for HumanName(for example HumanName.given, - # HumanName.family) can be omitted. + # The sub-type for HumanName, such as HumanName.given or + # HumanName.family, can be omitted. # Corresponds to the JSON property `paths` # @return [Array] attr_accessor :paths @@ -1385,9 +1386,9 @@ module Google end # Response when all resources export successfully. - # This structure will be included in the + # This structure is included in the # response to describe the detailed - # outcome. It will only be included when the operation finishes successfully. + # outcome after the operation finishes successfully. class GoogleCloudHealthcareV1beta1FhirRestExportResourcesResponse include Google::Apis::Core::Hashable @@ -1421,7 +1422,7 @@ module Google # URI for a Cloud Storage directory where result files should be written (in # the format `gs://`bucket-id`/`path/to/destination/dir``). If there is no - # trailing slash, the service will append one when composing the object path. + # trailing slash, the service appends one when composing the object path. # The user is responsible for creating the Cloud Storage bucket referenced in # `uri_prefix`. # Corresponds to the JSON property `uriPrefix` @@ -1472,10 +1473,10 @@ module Google end # Error response of importing resources. - # This structure will be included in the + # This structure is included in the # error - # details to describe the detailed error. It will - # only be included when the operation finishes with some failure. + # details to describe the detailed error + # after the operation finishes with some failure. class GoogleCloudHealthcareV1beta1FhirRestImportResourcesErrorDetails include Google::Apis::Core::Hashable @@ -1517,9 +1518,9 @@ module Google end # Final response of importing resources. - # This structure will be included in the + # This structure is included in the # response to describe the detailed - # outcome. It will only be included when the operation finishes successfully. + # outcome after the operation finishes successfully. class GoogleCloudHealthcareV1beta1FhirRestImportResourcesResponse include Google::Apis::Core::Hashable @@ -1635,7 +1636,7 @@ module Google # Restricts notifications sent for messages matching a filter. If this is # empty, all messages are matched. Syntax: # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # Fields/functions available for filtering are: + # The following fields and functions are available for filtering: # * `message_type`, from the MSH-9.1 field. For example, # `NOT message_type = "ADT"`. # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in @@ -1664,16 +1665,16 @@ module Google # * `PubsubMessage.Data` contains the resource name. # * `PubsubMessage.MessageId` is the ID of this notification. It is # guaranteed to be unique within the topic. - # * `PubsubMessage.PublishTime` is the time at which the message was + # * `PubsubMessage.PublishTime` is the time when the message was # published. # Note that notifications are only sent if the topic is non-empty. [Topic # names](https://cloud.google.com/pubsub/docs/overview#names) must be # scoped to a project. Cloud Healthcare API service account must have # publisher permissions on the given Pub/Sub topic. Not having adequate # permissions causes the calls that send notifications to fail. - # If a notification cannot be published to Cloud Pub/Sub, errors will be - # logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how- - # tos/logging)). + # If a notification can't be published to Cloud Pub/Sub, errors are + # logged to Cloud Logging. For more information, see + # [Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging). # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic @@ -1731,7 +1732,7 @@ module Google # @return [Google::Apis::HealthcareV1beta1::ParserConfig] attr_accessor :parser_config - # Determines whether duplicate messages should be rejected. A duplicate + # Determines whether to reject duplicate messages. A duplicate # message is a message with the same raw bytes as a message that has already # been ingested/created in this HL7v2 store. # The default value is false, meaning that the store accepts the duplicate @@ -1936,8 +1937,8 @@ module Google # Pseudonymization method that generates surrogates via cryptographic hashing. # Uses SHA-256. - # Outputs a base64-encoded representation of the hashed output - # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). + # Outputs a base64-encoded representation of the hashed output. + # For example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`. # Corresponds to the JSON property `cryptoHashConfig` # @return [Google::Apis::HealthcareV1beta1::CryptoHashConfig] attr_accessor :crypto_hash_config @@ -1991,8 +1992,9 @@ module Google include Google::Apis::Core::Hashable # A complete HL7v2 message. - # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details - # on the standard. + # See [Introduction to HL7 Standards] + # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for + # details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1beta1::Message] attr_accessor :message @@ -2019,8 +2021,9 @@ module Google attr_accessor :hl7_ack # A complete HL7v2 message. - # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details - # on the standard. + # See [Introduction to HL7 Standards] + # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for + # details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1beta1::Message] attr_accessor :message @@ -2270,8 +2273,9 @@ module Google end # A complete HL7v2 message. - # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details - # on the standard. + # See [Introduction to HL7 Standards] + # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for + # details on the standard. class Message include Google::Apis::Core::Hashable @@ -2987,9 +2991,9 @@ module Google # The FHIR resource type to search, such as Patient or Observation. For a # complete list, see the FHIR Resource Index - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), + # [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -3174,7 +3178,7 @@ module Google end end - # This structure contains configuration for streaming FHIR export. + # Contains configuration for streaming FHIR export. class StreamConfig include Google::Apis::Core::Hashable @@ -3210,7 +3214,7 @@ module Google # Tags to be filtered. Tags must be DICOM Data Elements, File Meta # Elements, or Directory Structuring Elements, as defined at: # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. - # They may be provided by "Keyword" or "Tag". For example "PatientID", + # They may be provided by "Keyword" or "Tag". For example, "PatientID", # "00100010". # Corresponds to the JSON property `tags` # @return [Array] diff --git a/generated/google/apis/healthcare_v1beta1/service.rb b/generated/google/apis/healthcare_v1beta1/service.rb index 55026243d..3953e09bc 100644 --- a/generated/google/apis/healthcare_v1beta1/service.rb +++ b/generated/google/apis/healthcare_v1beta1/service.rb @@ -947,7 +947,8 @@ module Google end # SearchForInstances returns a list of matching instances. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -985,7 +986,8 @@ module Google end # SearchForSeries returns a list of matching series. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1022,7 +1024,8 @@ module Google end # SearchForStudies returns a list of matching studies. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1095,7 +1098,9 @@ module Google # StoreInstances stores DICOM instances associated with study instance unique # identifiers (SUID). See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. + # [Store + # Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18. + # html#sect_10.5). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1208,7 +1213,8 @@ module Google # RetrieveStudyMetadata returns instance associated with the given study # presented as metadata with the bulk data removed. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1245,7 +1251,8 @@ module Google end # RetrieveStudy returns all instances within the given study. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1282,7 +1289,8 @@ module Google end # SearchForInstances returns a list of matching instances. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1320,7 +1328,8 @@ module Google end # SearchForSeries returns a list of matching series. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1358,7 +1367,9 @@ module Google # StoreInstances stores DICOM instances associated with study instance unique # identifiers (SUID). See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. + # [Store + # Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18. + # html#sect_10.5). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1437,7 +1448,8 @@ module Google # RetrieveSeriesMetadata returns instance associated with the given study and # series, presented as metadata with the bulk data removed. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1474,7 +1486,8 @@ module Google end # RetrieveSeries returns all instances within the given study and series. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1511,7 +1524,8 @@ module Google end # SearchForInstances returns a list of matching instances. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1588,7 +1602,8 @@ module Google # RetrieveInstance returns instance associated with the given study, series, # and SOP Instance UID. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1627,7 +1642,8 @@ module Google # RetrieveInstanceMetadata returns instance associated with the given study, # series, and SOP Instance UID presented as metadata with the bulk data # removed. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1665,7 +1681,8 @@ module Google # RetrieveRenderedInstance returns instance associated with the given study, # series, and SOP Instance UID in an acceptable Rendered Media Type. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1703,7 +1720,8 @@ module Google # RetrieveFrames returns instances associated with the given study, series, # SOP Instance UID and frame numbers. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1743,7 +1761,8 @@ module Google # RetrieveRenderedFrames returns instances associated with the given study, # series, SOP Instance UID and frame numbers in an acceptable Rendered Media # Type. See - # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] parent # The name of the DICOM store that is being accessed. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1906,8 +1925,7 @@ module Google # The metadata field type for this # operation is OperationMetadata. # @param [String] name - # The name of the FHIR store to export resource from. The name should be in - # the format of + # The name of the FHIR store to export resource from, in the format of # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ # fhirStores/`fhir_store_id``. # @param [Google::Apis::HealthcareV1beta1::ExportResourcesRequest] export_resources_request_object @@ -2021,8 +2039,8 @@ module Google # an empty FHIR store that is not being used by other clients. In cases # where this method is not appropriate, consider using ExecuteBundle to # load data. - # Every resource in the input must contain a client-supplied ID, and will be - # stored using that ID regardless of the + # Every resource in the input must contain a client-supplied ID. Each + # resource is stored using the supplied ID regardless of the # enable_update_create setting on the FHIR # store. # The import process does not enforce referential integrity, regardless of @@ -2044,10 +2062,10 @@ module Google # more than once. # The import operation is idempotent unless the input data contains multiple # valid resources with the same ID but different contents. In that case, - # after the import completes, the store will contain exactly one resource + # after the import completes, the store contains exactly one resource # with that ID but there is no ordering guarantee on which version of the # contents it will have. The operation result counters do not count - # duplicate IDs as an error and will count one success for each resource in + # duplicate IDs as an error and count one success for each resource in # the input, which might result in a success count larger than the number # of resources in the FHIR store. This often occurs when importing data # organized in bundles produced by Patient-everything @@ -2079,8 +2097,7 @@ module Google # The metadata field type for this # operation is OperationMetadata. # @param [String] name - # The name of the FHIR store to import FHIR resources to. The name should be - # in the format of + # The name of the FHIR store to import FHIR resources to, in the format of # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ # fhirStores/`fhir_store_id``. # @param [Google::Apis::HealthcareV1beta1::ImportResourcesRequest] import_resources_request_object @@ -2388,9 +2405,9 @@ module Google # search criteria specified as query parameters, grouped by # `Observation.code`, sorted from most recent to oldest. # Implements the FHIR extended operation Observation-lastn - # ([STU3](http://hl7.org/implement/standards/fhir/STU3/observation-operations. + # ([STU3](https://hl7.org/implement/standards/fhir/STU3/observation-operations. # html#lastn), - # [R4](http://hl7.org/implement/standards/fhir/R4/observation-operations.html# + # [R4](https://hl7.org/implement/standards/fhir/R4/observation-operations.html# # lastn)). # DSTU2 doesn't define the Observation-lastn method, but the server supports # it the same way it supports STU3. @@ -2408,10 +2425,10 @@ module Google # grouping and limiting the results with `max`. To stay within the limit, # constrain these searches using Observation search parameters such as # `_lastUpdated` or `date`. - # On success, the response body will contain a JSON-encoded representation + # On success, the response body contains a JSON-encoded representation # of a `Bundle` resource of type `searchset`, containing the results of the # operation. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -2446,16 +2463,16 @@ module Google # Retrieves a Patient resource and resources related to that patient. # Implements the FHIR extended operation Patient-everything - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html# + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/patient-operations. + # html#everything), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/patient-operations.html# # everything), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html# - # everything), - # [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html# + # [R4](https://hl7.org/implement/standards/fhir/R4/patient-operations.html# # everything)). - # On success, the response body will contain a JSON-encoded representation + # On success, the response body contains a JSON-encoded representation # of a `Bundle` resource of type `searchset`, containing the results of the # operation. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -2465,9 +2482,9 @@ module Google # * Resources directly referencing the patient resource that meet the # inclusion criteria. The inclusion criteria are based on the membership # rules in the patient compartment definition - # ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), + # ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), # [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), - # [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which + # [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which # details the eligible resource types and referencing search parameters. # @param [String] name # Name of the `Patient` resource for which the information is required. @@ -2475,8 +2492,8 @@ module Google # Maximum number of resources in a page. Defaults to 100. # @param [String] _page_token # Used to retrieve the next or previous page of results - # when using pagination. Value should be set to the value of page_token set - # in next or previous page links' urls. Next and previous page are returned + # when using pagination. Value should be set to the value of `page_token` set + # in next or previous page links' URLs. Next and previous page are returned # in the response bundle's links field, where `link.relation` is "previous" # or "next". # Omit `page_token` if no previous request has been made. @@ -2551,20 +2568,21 @@ module Google end # Gets the FHIR capability statement - # ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), + # ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html) + # , + # [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), # or the [conformance - # statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) + # statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) # in the DSTU2 case for the store, which contains a description of # functionality supported by the server. # Implements the FHIR standard capabilities interaction - # ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), + # ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), # or the [conformance - # interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html# + # interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html# # conformance) # in the DSTU2 case. - # On success, the response body will contain a JSON-encoded representation + # On success, the response body contains a JSON-encoded representation # of a `CapabilityStatement` resource. # @param [String] name # Name of the FHIR store to retrieve the capabilities for. @@ -2597,15 +2615,15 @@ module Google # Deletes FHIR resources that match a search query. # Implements the FHIR standard conditional delete interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)). - # If multiple resources match, all of them will be deleted. + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)). + # If multiple resources match, all matching resources are deleted. # Search terms are provided as query parameters following the same pattern as # the search method. # Note: Unless resource versioning is disabled by setting the # disable_resource_versioning flag - # on the FHIR store, the deleted resources will be moved to a history + # on the FHIR store, the deleted resources are moved to a history # repository that can still be retrieved through vread # and related methods, unless they are removed by the # purge method. @@ -2616,9 +2634,9 @@ module Google # @param [String] type # The FHIR resource type to delete, such as Patient or Observation. For a # complete list, see the FHIR Resource Index - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), + # [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2651,19 +2669,19 @@ module Google # parameters, updates part of that resource by applying the operations # specified in a [JSON Patch](http://jsonpatch.com/) document. # Implements the FHIR standard conditional patch interaction - # ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)). + # ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#patch), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#patch)). # DSTU2 doesn't define a conditional patch method, but the server supports it # in the same way it supports STU3. # Search terms are provided as query parameters following the same pattern as # the search method. - # If the search criteria identify more than one match, the request will - # return a `412 Precondition Failed` error. + # If the search criteria identify more than one match, the request + # returns a `412 Precondition Failed` error. # The request body must contain a JSON Patch document, and the request # headers must contain `Content-Type: application/json-patch+json`. - # On success, the response body will contain a JSON-encoded representation + # On success, the response body contains a JSON-encoded representation # of the updated resource, including the server-assigned version ID. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -2675,9 +2693,9 @@ module Google # @param [String] type # The FHIR resource type to update, such as Patient or Observation. For a # complete list, see the FHIR Resource Index - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), + # [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2712,25 +2730,25 @@ module Google # If a resource is found based on the search criteria specified in the query # parameters, updates the entire contents of that resource. # Implements the FHIR standard conditional update interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#cond-update)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#cond-update), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#cond-update)). # Search terms are provided as query parameters following the same pattern as # the search method. - # If the search criteria identify more than one match, the request will - # return a `412 Precondition Failed` error. + # If the search criteria identify more than one match, the request + # returns a `412 Precondition Failed` error. # If the search criteria identify zero matches, and the supplied resource # body contains an `id`, and the FHIR store has # enable_update_create set, creates the # resource with the client-specified ID. If the search criteria identify zero # matches, and the supplied resource body does not contain an `id`, the - # resource will be created with a server-assigned ID as per the + # resource is created with a server-assigned ID as per the # create method. # The request body must contain a JSON-encoded FHIR resource, and the request # headers must contain `Content-Type: application/fhir+json`. - # On success, the response body will contain a JSON-encoded representation + # On success, the response body contains a JSON-encoded representation # of the updated resource, including the server-assigned version ID. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -2741,9 +2759,9 @@ module Google # @param [String] type # The FHIR resource type to update, such as Patient or Observation. For a # complete list, see the FHIR Resource Index - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), + # [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). # Must match the resource type in the provided content. # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object # @param [String] fields @@ -2778,23 +2796,23 @@ module Google # Creates a FHIR resource. # Implements the FHIR standard create interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#create), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#create), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#create)), # which creates a new resource with a server-assigned resource ID. # Also supports the FHIR standard conditional create interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), # specified by supplying an `If-None-Exist` header containing a FHIR search # query. If no resources match this search query, the server processes the # create operation as normal. # The request body must contain a JSON-encoded FHIR resource, and the request # headers must contain `Content-Type: application/fhir+json`. - # On success, the response body will contain a JSON-encoded representation + # On success, the response body contains a JSON-encoded representation # of the resource as it was created on the server, including the # server-assigned resource ID and version ID. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -2803,9 +2821,9 @@ module Google # @param [String] type # The FHIR resource type to create, such as Patient or Observation. For a # complete list, see the FHIR Resource Index - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), + # [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). # Must match the resource type in the provided content. # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object # @param [String] fields @@ -2840,12 +2858,12 @@ module Google # Deletes a FHIR resource. # Implements the FHIR standard delete interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#delete), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#delete)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#delete), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#delete)). # Note: Unless resource versioning is disabled by setting the # disable_resource_versioning flag - # on the FHIR store, the deleted resources will be moved to a history + # on the FHIR store, the deleted resources are moved to a history # repository that can still be retrieved through vread # and related methods, unless they are removed by the # purge method. @@ -2880,26 +2898,26 @@ module Google # Executes all the requests in the given Bundle. # Implements the FHIR standard batch/transaction interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#transaction)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). # Supports all interactions within a bundle, except search. This method # accepts Bundles of type `batch` and `transaction`, processing them # according to the batch processing rules - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#brules)) + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) # and transaction processing rules - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#trules)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). # The request body must contain a JSON-encoded FHIR `Bundle` resource, and # the request headers must contain `Content-Type: application/fhir+json`. - # For a batch bundle or a successful transaction the response body will - # contain a JSON-encoded representation of a `Bundle` resource of type + # For a batch bundle or a successful transaction the response body + # contains a JSON-encoded representation of a `Bundle` resource of type # `batch-response` or `transaction-response` containing one entry for each # entry in the request, with the outcome of processing the entry. In the - # case of an error for a transaction bundle, the response body will contain + # case of an error for a transaction bundle, the response body contains # a JSON-encoded `OperationOutcome` resource describing the reason for the # error. If the request cannot be mapped to a valid API method on a FHIR # store, a generic GCP error might be returned instead. @@ -2944,13 +2962,13 @@ module Google # Lists all the versions of a resource (including the current version and # deleted versions) from the FHIR store. # Implements the per-resource form of the FHIR standard history interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#history)). - # On success, the response body will contain a JSON-encoded representation + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#history), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#history), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#history)). + # On success, the response body contains a JSON-encoded representation # of a `Bundle` resource of type `history`, containing the version history # sorted from most recent to oldest versions. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -3014,15 +3032,15 @@ module Google # Updates part of an existing resource by applying the operations specified # in a [JSON Patch](http://jsonpatch.com/) document. # Implements the FHIR standard patch interaction - # ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)). + # ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#patch), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#patch)). # DSTU2 doesn't define a patch method, but the server supports it in the same # way it supports STU3. # The request body must contain a JSON Patch document, and the request # headers must contain `Content-Type: application/json-patch+json`. - # On success, the response body will contain a JSON-encoded representation + # On success, the response body contains a JSON-encoded representation # of the updated resource, including the server-assigned version ID. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -3060,18 +3078,18 @@ module Google # Gets the contents of a FHIR resource. # Implements the FHIR standard read interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#read), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#read)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#read), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#read), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#read)). # Also supports the FHIR standard conditional read interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cread), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#cread)) + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#cread), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#cread)) # specified by supplying an `If-Modified-Since` header with a date/time value # or an `If-None-Match` header with an ETag value. - # On success, the response body will contain a JSON-encoded representation + # On success, the response body contains a JSON-encoded representation # of the resource. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -3107,13 +3125,13 @@ module Google # Searches for resources in the given FHIR store according to criteria # specified as query parameters. # Implements the FHIR standard search interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) # using the search semantics described in the FHIR Search specification - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), + # [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). # Supports three methods of search defined by the specification: # * `GET [base]?[parameters]` to search across all resources. # * `GET [base]/[type]?[parameters]` to search resources of a specified @@ -3122,10 +3140,10 @@ module Google # the same semantics as the `GET` method. # The `GET` methods do not support compartment searches. The `POST` method # does not support `application/x-www-form-urlencoded` search parameters. - # On success, the response body will contain a JSON-encoded representation + # On success, the response body contains a JSON-encoded representation # of a `Bundle` resource of type `searchset`, containing the results of the # search. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -3134,10 +3152,10 @@ module Google # are supported on each FHIR resource. A list of all search parameters # defined by the specification can be found in the FHIR Search Parameter # Registry - # ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry. + # ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry. # html), - # [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)) - # . + # [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html) + # ). # FHIR search parameters for DSTU2 can be found on each resource's definition # page. # Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, @@ -3146,7 +3164,7 @@ module Google # `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. # The maximum number of search results returned defaults to 100, which can # be overridden by the `_count` parameter up to a maximum limit of 1000. If - # there are additional results, the returned `Bundle` will contain + # there are additional results, the returned `Bundle` contains # pagination links. # Resources with a total size larger than 5MB or a field count larger than # 50,000 might not be fully searchable as the server might trim its generated @@ -3188,9 +3206,9 @@ module Google # Updates the entire contents of a resource. # Implements the FHIR standard update interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#update), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#update), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#update)). # If the specified resource does # not exist and the FHIR store has # enable_update_create set, creates the @@ -3199,9 +3217,9 @@ module Google # headers must contain `Content-Type: application/fhir+json`. The resource # must contain an `id` element having an identical value to the ID in the # REST path of the request. - # On success, the response body will contain a JSON-encoded representation + # On success, the response body contains a JSON-encoded representation # of the updated resource, including the server-assigned version ID. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -3240,12 +3258,12 @@ module Google # Gets the contents of a version (current or historical) of a FHIR resource # by version ID. # Implements the FHIR standard vread interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#vread)). - # On success, the response body will contain a JSON-encoded representation + # ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), + # [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#vread), + # [R4](https://hl7.org/implement/standards/fhir/R4/http.html#vread)). + # On success, the response body contains a JSON-encoded representation # of the resource. - # Errors generated by the FHIR store will contain a JSON-encoded + # Errors generated by the FHIR store contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. @@ -3315,8 +3333,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified HL7v2 store and removes all messages that are - # contained within it. + # Deletes the specified HL7v2 store and removes all messages that it + # contains. # @param [String] name # The resource name of the HL7v2 store to delete. # @param [String] fields @@ -3723,7 +3741,7 @@ module Google # @param [String] filter # Restricts messages returned to those matching a filter. Syntax: # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # Fields/functions available for filtering are: + # The following fields and functions are available for filtering: # * `message_type`, from the MSH-9.1 field. For example, # `NOT message_type = "ADT"`. # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in @@ -3790,7 +3808,7 @@ module Google # Update the message. # The contents of the message in Message.data and data extracted from - # the contents such as Message.create_time cannot be altered. Only the + # the contents such as Message.create_time can't be altered. Only the # Message.labels field is allowed to be updated. The labels in the # request are merged with the existing set of labels. Existing labels with # the same keys are updated. diff --git a/generated/google/apis/homegraph_v1.rb b/generated/google/apis/homegraph_v1.rb index 26d68233c..e6c50261d 100644 --- a/generated/google/apis/homegraph_v1.rb +++ b/generated/google/apis/homegraph_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/actions/smarthome/create-app#request-sync module HomegraphV1 VERSION = 'V1' - REVISION = '20200415' + REVISION = '20200522' end end end diff --git a/generated/google/apis/homegraph_v1/classes.rb b/generated/google/apis/homegraph_v1/classes.rb index 8f082e32b..47b856b15 100644 --- a/generated/google/apis/homegraph_v1/classes.rb +++ b/generated/google/apis/homegraph_v1/classes.rb @@ -476,6 +476,9 @@ module Google attr_accessor :event_id # Token to maintain state in the follow up notification response. + # Deprecated. See the [notifications + # guide](https://developers.google.com/assistant/smarthome/develop/notifications) + # for details on implementing follow up notifications. # Corresponds to the JSON property `followUpToken` # @return [String] attr_accessor :follow_up_token diff --git a/generated/google/apis/iam_v1.rb b/generated/google/apis/iam_v1.rb index 65bbd2381..099d2e1e8 100644 --- a/generated/google/apis/iam_v1.rb +++ b/generated/google/apis/iam_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/iam/ module IamV1 VERSION = 'V1' - REVISION = '20200221' + REVISION = '20200515' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/iam_v1/classes.rb b/generated/google/apis/iam_v1/classes.rb index 9d8b361b1..6b66a839e 100644 --- a/generated/google/apis/iam_v1/classes.rb +++ b/generated/google/apis/iam_v1/classes.rb @@ -886,10 +886,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -904,7 +907,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -982,6 +987,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -1454,10 +1462,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -1472,7 +1483,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -1510,8 +1523,7 @@ module Google # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: - # paths: "bindings, etag" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/iam_v1/service.rb b/generated/google/apis/iam_v1/service.rb index c1e160046..799ac79e4 100644 --- a/generated/google/apis/iam_v1/service.rb +++ b/generated/google/apis/iam_v1/service.rb @@ -899,6 +899,10 @@ module Google # Disabling a service account that is bound to VMs, Apps, Functions, or # other jobs will cause those jobs to lose access to resources if they are # using the disabled service account. + # Previously issued Access tokens for a service account will be rejected + # while the service account is disabled but will start working again if the + # account is re-enabled. Issuance of new tokens will fail while the account + # is disabled. # To improve reliability of your services and avoid unexpected outages, it # is recommended to first disable a service account rather than delete it. # After disabling the service account, wait at least 24 hours to verify there @@ -1041,6 +1045,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user