Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Add the following lines to your `pom.xml` file:
<dependency>
<groupId>com.google.apis</groupId>
<artifactId>google-api-services-healthcare</artifactId>
<version>v1beta1-rev20260908-2.0.0</version>
<version>v1beta1-rev20260924-2.0.0</version>
</dependency>
</dependencies>
</project>
Expand All @@ -35,7 +35,7 @@ repositories {
mavenCentral()
}
dependencies {
implementation 'com.google.apis:google-api-services-healthcare:v1beta1-rev20260908-2.0.0'
implementation 'com.google.apis:google-api-services-healthcare:v1beta1-rev20260924-2.0.0'
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18582,6 +18582,159 @@ public Delete set(String parameterName, Object value) {
return (Delete) super.set(parameterName, value);
}
}
/**
* Executes and materializes a cohort definition from a FHIR store. This method returns an Operation
* that can be used to track the status of the cohort execution by calling GetOperation. Immediate
* fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing
* error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
* Otherwise, when the operation finishes, a detailed response of type ExecuteCohortResponse is
* returned in the response field. The metadata field type for this operation is OperationMetadata.
*
* Create a request for the method "fhirStores.executeCohort".
*
* This request holds the parameters needed by the healthcare server. After setting any optional
* parameters, call the {@link ExecuteCohort#execute()} method to invoke the remote operation.
*
* @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}
* @return the request
*/
public ExecuteCohort executeCohort(java.lang.String name, com.google.api.services.healthcare.v1beta1.model.ExecuteCohortRequest content) throws java.io.IOException {
ExecuteCohort result = new ExecuteCohort(name, content);
initialize(result);
return result;
}

public class ExecuteCohort extends CloudHealthcareRequest<com.google.api.services.healthcare.v1beta1.model.Operation> {

private static final String REST_PATH = "v1beta1/{+name}:executeCohort";

private final java.util.regex.Pattern NAME_PATTERN =
java.util.regex.Pattern.compile("^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$");

/**
* Executes and materializes a cohort definition from a FHIR store. This method returns an
* Operation that can be used to track the status of the cohort execution by calling GetOperation.
* Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see
* [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-
* tos/logging)). Otherwise, when the operation finishes, a detailed response of type
* ExecuteCohortResponse is returned in the response field. The metadata field type for this
* operation is OperationMetadata.
*
* Create a request for the method "fhirStores.executeCohort".
*
* This request holds the parameters needed by the the healthcare server. After setting any
* optional parameters, call the {@link ExecuteCohort#execute()} method to invoke the remote
* operation. <p> {@link ExecuteCohort#initialize(com.google.api.client.googleapis.services.Abstra
* ctGoogleClientRequest)} must be called to initialize this instance immediately after invoking
* the constructor. </p>
*
* @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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -172,19 +171,17 @@ 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() {
return validateOnly;
}

/**
* 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) {
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
*
* <p> 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:
* <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
* </p>
*
* @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();
}

}
Loading
Loading