{@link ExecuteCohort#initialize(com.google.api.client.googleapis.services.Abstra + * ctGoogleClientRequest)} must be called to initialize this instance immediately after invoking + * the constructor.
+ * + * @param name Required. The name of the FHIR store to query, in the format + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_stor + * e_id}`. + * @param content the {@link com.google.api.services.healthcare.v1beta1.model.ExecuteCohortRequest} + * @since 1.13 + */ + protected ExecuteCohort(java.lang.String name, com.google.api.services.healthcare.v1beta1.model.ExecuteCohortRequest content) { + super(CloudHealthcare.this, "POST", REST_PATH, content, com.google.api.services.healthcare.v1beta1.model.Operation.class); + this.name = com.google.api.client.util.Preconditions.checkNotNull(name, "Required parameter name must be specified."); + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$"); + } + } + + @Override + public ExecuteCohort set$Xgafv(java.lang.String $Xgafv) { + return (ExecuteCohort) super.set$Xgafv($Xgafv); + } + + @Override + public ExecuteCohort setAccessToken(java.lang.String accessToken) { + return (ExecuteCohort) super.setAccessToken(accessToken); + } + + @Override + public ExecuteCohort setAlt(java.lang.String alt) { + return (ExecuteCohort) super.setAlt(alt); + } + + @Override + public ExecuteCohort setCallback(java.lang.String callback) { + return (ExecuteCohort) super.setCallback(callback); + } + + @Override + public ExecuteCohort setFields(java.lang.String fields) { + return (ExecuteCohort) super.setFields(fields); + } + + @Override + public ExecuteCohort setKey(java.lang.String key) { + return (ExecuteCohort) super.setKey(key); + } + + @Override + public ExecuteCohort setOauthToken(java.lang.String oauthToken) { + return (ExecuteCohort) super.setOauthToken(oauthToken); + } + + @Override + public ExecuteCohort setPrettyPrint(java.lang.Boolean prettyPrint) { + return (ExecuteCohort) super.setPrettyPrint(prettyPrint); + } + + @Override + public ExecuteCohort setQuotaUser(java.lang.String quotaUser) { + return (ExecuteCohort) super.setQuotaUser(quotaUser); + } + + @Override + public ExecuteCohort setUploadType(java.lang.String uploadType) { + return (ExecuteCohort) super.setUploadType(uploadType); + } + + @Override + public ExecuteCohort setUploadProtocol(java.lang.String uploadProtocol) { + return (ExecuteCohort) super.setUploadProtocol(uploadProtocol); + } + + /** + * Required. The name of the FHIR store to query, in the format `projects/{project_id}/l + * ocations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + @com.google.api.client.util.Key + private java.lang.String name; + + /** Required. The name of the FHIR store to query, in the format + `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + public java.lang.String getName() { + return name; + } + + /** + * Required. The name of the FHIR store to query, in the format `projects/{project_id}/l + * ocations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + public ExecuteCohort setName(java.lang.String name) { + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$"); + } + this.name = name; + return this; + } + + @Override + public ExecuteCohort set(String parameterName, Object value) { + return (ExecuteCohort) super.set(parameterName, value); + } + } /** * Explains all the permitted/denied actor, purpose and environment for a given resource. FHIR * Consent is not supported in DSTU2 or R5. diff --git a/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/BulkDeleteResourcesRequest.java b/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/BulkDeleteResourcesRequest.java index 20b470ae65c..36b6123f704 100644 --- a/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/BulkDeleteResourcesRequest.java +++ b/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/BulkDeleteResourcesRequest.java @@ -68,9 +68,8 @@ public final class BulkDeleteResourcesRequest extends com.google.api.client.json private java.lang.String until; /** - * Optional. If set to true, the request will only perform a dry run. By default (once the - * behavior change is fully rolled out), this will default to true. During the transition period, - * the default depends on the Mendel flag status for the project. + * Optional. If set to `true`, the request will only perform a dry run. By default this will + * default to `false`. * The value may be {@code null}. */ @com.google.api.client.util.Key @@ -172,9 +171,8 @@ public BulkDeleteResourcesRequest setUntil(java.lang.String until) { } /** - * Optional. If set to true, the request will only perform a dry run. By default (once the - * behavior change is fully rolled out), this will default to true. During the transition period, - * the default depends on the Mendel flag status for the project. + * Optional. If set to `true`, the request will only perform a dry run. By default this will + * default to `false`. * @return value or {@code null} for none */ public java.lang.Boolean getValidateOnly() { @@ -182,9 +180,8 @@ public java.lang.Boolean getValidateOnly() { } /** - * Optional. If set to true, the request will only perform a dry run. By default (once the - * behavior change is fully rolled out), this will default to true. During the transition period, - * the default depends on the Mendel flag status for the project. + * Optional. If set to `true`, the request will only perform a dry run. By default this will + * default to `false`. * @param validateOnly validateOnly or {@code null} for none */ public BulkDeleteResourcesRequest setValidateOnly(java.lang.Boolean validateOnly) { diff --git a/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/ExecuteCohortRequest.java b/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/ExecuteCohortRequest.java new file mode 100644 index 00000000000..59de165f780 --- /dev/null +++ b/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/ExecuteCohortRequest.java @@ -0,0 +1,184 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except + * in compliance with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under the License + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express + * or implied. See the License for the specific language governing permissions and limitations under + * the License. + */ +/* + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ + * Modify at your own risk. + */ + +package com.google.api.services.healthcare.v1beta1.model; + +/** + * Request to execute a cohort definition from a FHIR store based on provided queries and sending + * the resulting subset of data to a specified sink. + * + *This is the Java data model class that specifies how to parse/serialize into the JSON that is + * transmitted over HTTP when working with the Cloud Healthcare API. For a detailed explanation see: + * https://developers.google.com/api-client-library/java/google-http-java-client/json + *
+ * + * @author Google, Inc. + */ +@SuppressWarnings("javadoc") +public final class ExecuteCohortRequest extends com.google.api.client.json.GenericJson { + + /** + * Optional. If provided, the queried resources will represent the state of the FHIR store at the + * given past timestamp. Runs the operation against the state of the store at this timestamp. + * State of the store is represented by the resource versions that were the current versions + * during the time specified or the resources that have not been updated since. Only works if the + * store has history enabled. Although users should be able to use this field to reproduce + * previous runs of the operation and get consistent results, there are a few cases where the past + * state of the store can be altered, thus resulting in no guarantee of reproducibility. For + * example, resource versions can be deleted using the purge method, or modified using + * ImportResourcesHistory. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key("_at") + private String at; + + /** + * Return resources that match the specified FHIRPath expressions. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private FHIRPathQuery fhirpathQuery; + + /** + * The Cloud Storage output destination. The Healthcare Service Agent account requires the + * `roles/storage.objectAdmin` role on the Cloud Storage location. The exported outputs are + * organized by FHIR resource types. The server creates one or more objects per resource type + * depending on the volume of the resources exported. When there is only one object per resource + * type, the object name is in the form of `{operation_id}_{resource_type}`. When there are + * multiple objects for a given resource type, the object names are in the form of + * `{operation_id}_{resource_type}-{index}-of-{total}`. Each object contains newline delimited + * JSON, and each line is a FHIR resource. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private GoogleCloudHealthcareV1beta1FhirGcsDestination gcsDestination; + + /** + * Optional. If true, the request will be validated but no cohort execution will be run. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.Boolean validateOnly; + + /** + * Optional. If provided, the queried resources will represent the state of the FHIR store at the + * given past timestamp. Runs the operation against the state of the store at this timestamp. + * State of the store is represented by the resource versions that were the current versions + * during the time specified or the resources that have not been updated since. Only works if the + * store has history enabled. Although users should be able to use this field to reproduce + * previous runs of the operation and get consistent results, there are a few cases where the past + * state of the store can be altered, thus resulting in no guarantee of reproducibility. For + * example, resource versions can be deleted using the purge method, or modified using + * ImportResourcesHistory. + * @return value or {@code null} for none + */ + public String getAt() { + return at; + } + + /** + * Optional. If provided, the queried resources will represent the state of the FHIR store at the + * given past timestamp. Runs the operation against the state of the store at this timestamp. + * State of the store is represented by the resource versions that were the current versions + * during the time specified or the resources that have not been updated since. Only works if the + * store has history enabled. Although users should be able to use this field to reproduce + * previous runs of the operation and get consistent results, there are a few cases where the past + * state of the store can be altered, thus resulting in no guarantee of reproducibility. For + * example, resource versions can be deleted using the purge method, or modified using + * ImportResourcesHistory. + * @param at at or {@code null} for none + */ + public ExecuteCohortRequest setAt(String at) { + this.at = at; + return this; + } + + /** + * Return resources that match the specified FHIRPath expressions. + * @return value or {@code null} for none + */ + public FHIRPathQuery getFhirpathQuery() { + return fhirpathQuery; + } + + /** + * Return resources that match the specified FHIRPath expressions. + * @param fhirpathQuery fhirpathQuery or {@code null} for none + */ + public ExecuteCohortRequest setFhirpathQuery(FHIRPathQuery fhirpathQuery) { + this.fhirpathQuery = fhirpathQuery; + return this; + } + + /** + * The Cloud Storage output destination. The Healthcare Service Agent account requires the + * `roles/storage.objectAdmin` role on the Cloud Storage location. The exported outputs are + * organized by FHIR resource types. The server creates one or more objects per resource type + * depending on the volume of the resources exported. When there is only one object per resource + * type, the object name is in the form of `{operation_id}_{resource_type}`. When there are + * multiple objects for a given resource type, the object names are in the form of + * `{operation_id}_{resource_type}-{index}-of-{total}`. Each object contains newline delimited + * JSON, and each line is a FHIR resource. + * @return value or {@code null} for none + */ + public GoogleCloudHealthcareV1beta1FhirGcsDestination getGcsDestination() { + return gcsDestination; + } + + /** + * The Cloud Storage output destination. The Healthcare Service Agent account requires the + * `roles/storage.objectAdmin` role on the Cloud Storage location. The exported outputs are + * organized by FHIR resource types. The server creates one or more objects per resource type + * depending on the volume of the resources exported. When there is only one object per resource + * type, the object name is in the form of `{operation_id}_{resource_type}`. When there are + * multiple objects for a given resource type, the object names are in the form of + * `{operation_id}_{resource_type}-{index}-of-{total}`. Each object contains newline delimited + * JSON, and each line is a FHIR resource. + * @param gcsDestination gcsDestination or {@code null} for none + */ + public ExecuteCohortRequest setGcsDestination(GoogleCloudHealthcareV1beta1FhirGcsDestination gcsDestination) { + this.gcsDestination = gcsDestination; + return this; + } + + /** + * Optional. If true, the request will be validated but no cohort execution will be run. + * @return value or {@code null} for none + */ + public java.lang.Boolean getValidateOnly() { + return validateOnly; + } + + /** + * Optional. If true, the request will be validated but no cohort execution will be run. + * @param validateOnly validateOnly or {@code null} for none + */ + public ExecuteCohortRequest setValidateOnly(java.lang.Boolean validateOnly) { + this.validateOnly = validateOnly; + return this; + } + + @Override + public ExecuteCohortRequest set(String fieldName, Object value) { + return (ExecuteCohortRequest) super.set(fieldName, value); + } + + @Override + public ExecuteCohortRequest clone() { + return (ExecuteCohortRequest) super.clone(); + } + +} diff --git a/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/ExecuteCohortResponse.java b/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/ExecuteCohortResponse.java new file mode 100644 index 00000000000..a49c62ffd03 --- /dev/null +++ b/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/ExecuteCohortResponse.java @@ -0,0 +1,71 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except + * in compliance with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under the License + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express + * or implied. See the License for the specific language governing permissions and limitations under + * the License. + */ +/* + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ + * Modify at your own risk. + */ + +package com.google.api.services.healthcare.v1beta1.model; + +/** + * Response when ExecuteCohort operation finishes querying all resources and sends them to a sink + * destination. This structure will be included in the response when the operation finishes + * successfully. + * + *This is the Java data model class that specifies how to parse/serialize into the JSON that is + * transmitted over HTTP when working with the Cloud Healthcare API. For a detailed explanation see: + * https://developers.google.com/api-client-library/java/google-http-java-client/json + *
+ * + * @author Google, Inc. + */ +@SuppressWarnings("javadoc") +public final class ExecuteCohortResponse extends com.google.api.client.json.GenericJson { + + /** + * The name of the queried FHIR store, in the format `projects/{project_id}/locations/{location_id + * }/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String fhirStore; + + /** + * The name of the queried FHIR store, in the format `projects/{project_id}/locations/{location_id + * }/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * @return value or {@code null} for none + */ + public java.lang.String getFhirStore() { + return fhirStore; + } + + /** + * The name of the queried FHIR store, in the format `projects/{project_id}/locations/{location_id + * }/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * @param fhirStore fhirStore or {@code null} for none + */ + public ExecuteCohortResponse setFhirStore(java.lang.String fhirStore) { + this.fhirStore = fhirStore; + return this; + } + + @Override + public ExecuteCohortResponse set(String fieldName, Object value) { + return (ExecuteCohortResponse) super.set(fieldName, value); + } + + @Override + public ExecuteCohortResponse clone() { + return (ExecuteCohortResponse) super.clone(); + } + +} diff --git a/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/Expression.java b/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/Expression.java new file mode 100644 index 00000000000..b463cab425f --- /dev/null +++ b/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/Expression.java @@ -0,0 +1,120 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except + * in compliance with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under the License + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express + * or implied. See the License for the specific language governing permissions and limitations under + * the License. + */ +/* + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ + * Modify at your own risk. + */ + +package com.google.api.services.healthcare.v1beta1.model; + +/** + * A FHIRPath expression. + * + *This is the Java data model class that specifies how to parse/serialize into the JSON that is + * transmitted over HTTP when working with the Cloud Healthcare API. For a detailed explanation see: + * https://developers.google.com/api-client-library/java/google-http-java-client/json + *
+ * + * @author Google, Inc. + */ +@SuppressWarnings("javadoc") +public final class Expression extends com.google.api.client.json.GenericJson { + + /** + * Required. FHIRPath expression used for evaluation against FHIR resources. Must be in the format + * `[/"Resource"/"DomainResource"].[expression]` Expressions are applied per single FHIR resource, + * so they can't span multiple base resource types. For example, expressions like + * `Patient.union(Encounter)` are invalid. For expressions involving more than one resource or + * resource type, consider using the FHIRPath `resolve()` method. Expressions are only allowed to + * evaluate to a boolean type or a single or collection of + * [FHIR.Resource](https://hl7.org/fhir/resource.html) types. Expressions evaluating to boolean + * would include the base resource in the result if the expression evaluates to `true`. + * Expressions evaluating to one or more FHIR.Resource types will include those resources in the + * result, e.g. `CareTeam.member.resolve()`. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String fhirpathExpression; + + /** + * Optional. Expressions with the same label will be grouped together under the same directory + * when exporting to Cloud Storage. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String label; + + /** + * Required. FHIRPath expression used for evaluation against FHIR resources. Must be in the format + * `[/"Resource"/"DomainResource"].[expression]` Expressions are applied per single FHIR resource, + * so they can't span multiple base resource types. For example, expressions like + * `Patient.union(Encounter)` are invalid. For expressions involving more than one resource or + * resource type, consider using the FHIRPath `resolve()` method. Expressions are only allowed to + * evaluate to a boolean type or a single or collection of + * [FHIR.Resource](https://hl7.org/fhir/resource.html) types. Expressions evaluating to boolean + * would include the base resource in the result if the expression evaluates to `true`. + * Expressions evaluating to one or more FHIR.Resource types will include those resources in the + * result, e.g. `CareTeam.member.resolve()`. + * @return value or {@code null} for none + */ + public java.lang.String getFhirpathExpression() { + return fhirpathExpression; + } + + /** + * Required. FHIRPath expression used for evaluation against FHIR resources. Must be in the format + * `[/"Resource"/"DomainResource"].[expression]` Expressions are applied per single FHIR resource, + * so they can't span multiple base resource types. For example, expressions like + * `Patient.union(Encounter)` are invalid. For expressions involving more than one resource or + * resource type, consider using the FHIRPath `resolve()` method. Expressions are only allowed to + * evaluate to a boolean type or a single or collection of + * [FHIR.Resource](https://hl7.org/fhir/resource.html) types. Expressions evaluating to boolean + * would include the base resource in the result if the expression evaluates to `true`. + * Expressions evaluating to one or more FHIR.Resource types will include those resources in the + * result, e.g. `CareTeam.member.resolve()`. + * @param fhirpathExpression fhirpathExpression or {@code null} for none + */ + public Expression setFhirpathExpression(java.lang.String fhirpathExpression) { + this.fhirpathExpression = fhirpathExpression; + return this; + } + + /** + * Optional. Expressions with the same label will be grouped together under the same directory + * when exporting to Cloud Storage. + * @return value or {@code null} for none + */ + public java.lang.String getLabel() { + return label; + } + + /** + * Optional. Expressions with the same label will be grouped together under the same directory + * when exporting to Cloud Storage. + * @param label label or {@code null} for none + */ + public Expression setLabel(java.lang.String label) { + this.label = label; + return this; + } + + @Override + public Expression set(String fieldName, Object value) { + return (Expression) super.set(fieldName, value); + } + + @Override + public Expression clone() { + return (Expression) super.clone(); + } + +} diff --git a/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/FHIRPathQuery.java b/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/FHIRPathQuery.java new file mode 100644 index 00000000000..23e4abb41b3 --- /dev/null +++ b/clients/google-api-services-healthcare/v1beta1/2.0.0/com/google/api/services/healthcare/v1beta1/model/FHIRPathQuery.java @@ -0,0 +1,107 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except + * in compliance with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under the License + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express + * or implied. See the License for the specific language governing permissions and limitations under + * the License. + */ +/* + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ + * Modify at your own risk. + */ + +package com.google.api.services.healthcare.v1beta1.model; + +/** + * A set of FHIRPath expressions that are used to filter the FHIR resources. These expressions do + * not maintain referential integrity on the resulting resources. Users are responsible for making + * sure the expressions are written in a way to ensure that if desired. + * + *This is the Java data model class that specifies how to parse/serialize into the JSON that is + * transmitted over HTTP when working with the Cloud Healthcare API. For a detailed explanation see: + * https://developers.google.com/api-client-library/java/google-http-java-client/json + *
+ * + * @author Google, Inc. + */ +@SuppressWarnings("javadoc") +public final class FHIRPathQuery extends com.google.api.client.json.GenericJson { + + /** + * Optional. FHIRPath engine version number, for example "1.0". Will use the latest version if not + * specified. For more details about the supported versions, see + * https://cloud.google.com/healthcare-api/private/docs/how-tos/fhir-execute-cohort#fhirpath- + * engine-versions. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String engineVersion; + + /** + * Required. List of FHIRPath expressions used for filtering the data. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.util.List