Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

docs(regen): updated javadocs from protos #40

Merged
merged 1 commit into from Dec 19, 2019
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -195,7 +195,7 @@ public final OperationsClient getOperationsClient() {
*
* @param projectId Required. The ID of the Google Cloud Platform project that the cluster belongs
* to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param cluster Required. The cluster to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -323,7 +323,7 @@ public final UnaryCallable<CreateClusterRequest, Operation> createClusterCallabl
* </code></pre>
*
* @param projectId Required. The ID of the Google Cloud Platform project the cluster belongs to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param clusterName Required. The cluster name.
* @param cluster Required. The changes to the cluster.
* @param updateMask Required. Specifies the path, relative to `Cluster`, of the field to update.
Expand Down Expand Up @@ -486,7 +486,7 @@ public final UnaryCallable<UpdateClusterRequest, Operation> updateClusterCallabl
*
* @param projectId Required. The ID of the Google Cloud Platform project that the cluster belongs
* to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param clusterName Required. The cluster name.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -611,7 +611,7 @@ public final UnaryCallable<DeleteClusterRequest, Operation> deleteClusterCallabl
*
* @param projectId Required. The ID of the Google Cloud Platform project that the cluster belongs
* to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param clusterName Required. The cluster name.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -697,7 +697,7 @@ public final UnaryCallable<GetClusterRequest, Cluster> getClusterCallable() {
*
* @param projectId Required. The ID of the Google Cloud Platform project that the cluster belongs
* to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListClustersPagedResponse listClusters(String projectId, String region) {
Expand Down Expand Up @@ -725,7 +725,7 @@ public final ListClustersPagedResponse listClusters(String projectId, String reg
*
* @param projectId Required. The ID of the Google Cloud Platform project that the cluster belongs
* to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param filter Optional. A filter constraining the clusters to list. Filters are case-sensitive
* and have the following syntax:
* <p>field = value [AND [field = value]] ...
Expand Down Expand Up @@ -862,7 +862,7 @@ public final UnaryCallable<ListClustersRequest, ListClustersResponse> listCluste
*
* @param projectId Required. The ID of the Google Cloud Platform project that the cluster belongs
* to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param clusterName Required. The cluster name.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down
Expand Up @@ -172,7 +172,7 @@ public JobControllerStub getStub() {
* </code></pre>
*
* @param projectId Required. The ID of the Google Cloud Platform project that the job belongs to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param job Required. The job resource.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -252,7 +252,7 @@ public final UnaryCallable<SubmitJobRequest, Job> submitJobCallable() {
* </code></pre>
*
* @param projectId Required. The ID of the Google Cloud Platform project that the job belongs to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param jobId Required. The job ID.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -337,7 +337,7 @@ public final UnaryCallable<GetJobRequest, Job> getJobCallable() {
* </code></pre>
*
* @param projectId Required. The ID of the Google Cloud Platform project that the job belongs to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListJobsPagedResponse listJobs(String projectId, String region) {
Expand All @@ -364,7 +364,7 @@ public final ListJobsPagedResponse listJobs(String projectId, String region) {
* </code></pre>
*
* @param projectId Required. The ID of the Google Cloud Platform project that the job belongs to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param filter Optional. A filter constraining the jobs to list. Filters are case-sensitive and
* have the following syntax:
* <p>[field = value] AND [field [= value]] ...
Expand Down Expand Up @@ -551,7 +551,7 @@ public final UnaryCallable<UpdateJobRequest, Job> updateJobCallable() {
* </code></pre>
*
* @param projectId Required. The ID of the Google Cloud Platform project that the job belongs to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param jobId Required. The job ID.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -640,7 +640,7 @@ public final UnaryCallable<CancelJobRequest, Job> cancelJobCallable() {
* </code></pre>
*
* @param projectId Required. The ID of the Google Cloud Platform project that the job belongs to.
* @param region Required. The Cloud Dataproc region in which to handle the request.
* @param region Required. The Dataproc region in which to handle the request.
* @param jobId Required. The job ID.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down
Expand Up @@ -41,7 +41,7 @@

// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: The API interface for managing Workflow Templates in the Cloud Dataproc API.
* Service Description: The API interface for managing Workflow Templates in the Dataproc API.
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
Expand Down
Expand Up @@ -56,8 +56,7 @@
*
* ============================= WorkflowTemplateServiceClient =============================
*
* <p>Service Description: The API interface for managing Workflow Templates in the Cloud Dataproc
* API.
* <p>Service Description: The API interface for managing Workflow Templates in the Dataproc API.
*
* <p>Sample for WorkflowTemplateServiceClient:
*
Expand Down
Expand Up @@ -27,7 +27,7 @@
*
* <pre>
* The API interface for managing autoscaling policies in the
* Google Cloud Dataproc API.
* Dataproc API.
* </pre>
*/
@javax.annotation.Generated(
Expand Down Expand Up @@ -377,7 +377,7 @@ public static AutoscalingPolicyServiceFutureStub newFutureStub(io.grpc.Channel c
*
* <pre>
* The API interface for managing autoscaling policies in the
* Google Cloud Dataproc API.
* Dataproc API.
* </pre>
*/
public abstract static class AutoscalingPolicyServiceImplBase implements io.grpc.BindableService {
Expand Down Expand Up @@ -500,7 +500,7 @@ public final io.grpc.ServerServiceDefinition bindService() {
*
* <pre>
* The API interface for managing autoscaling policies in the
* Google Cloud Dataproc API.
* Dataproc API.
* </pre>
*/
public static final class AutoscalingPolicyServiceStub
Expand Down Expand Up @@ -612,7 +612,7 @@ public void deleteAutoscalingPolicy(
*
* <pre>
* The API interface for managing autoscaling policies in the
* Google Cloud Dataproc API.
* Dataproc API.
* </pre>
*/
public static final class AutoscalingPolicyServiceBlockingStub
Expand Down Expand Up @@ -706,7 +706,7 @@ public com.google.protobuf.Empty deleteAutoscalingPolicy(
*
* <pre>
* The API interface for managing autoscaling policies in the
* Google Cloud Dataproc API.
* Dataproc API.
* </pre>
*/
public static final class AutoscalingPolicyServiceFutureStub
Expand Down
Expand Up @@ -27,7 +27,7 @@
*
* <pre>
* The API interface for managing Workflow Templates in the
* Cloud Dataproc API.
* Dataproc API.
* </pre>
*/
@javax.annotation.Generated(
Expand Down Expand Up @@ -506,7 +506,7 @@ public static WorkflowTemplateServiceFutureStub newFutureStub(io.grpc.Channel ch
*
* <pre>
* The API interface for managing Workflow Templates in the
* Cloud Dataproc API.
* Dataproc API.
* </pre>
*/
public abstract static class WorkflowTemplateServiceImplBase implements io.grpc.BindableService {
Expand Down Expand Up @@ -703,7 +703,7 @@ public final io.grpc.ServerServiceDefinition bindService() {
*
* <pre>
* The API interface for managing Workflow Templates in the
* Cloud Dataproc API.
* Dataproc API.
* </pre>
*/
public static final class WorkflowTemplateServiceStub
Expand Down Expand Up @@ -881,7 +881,7 @@ public void deleteWorkflowTemplate(
*
* <pre>
* The API interface for managing Workflow Templates in the
* Cloud Dataproc API.
* Dataproc API.
* </pre>
*/
public static final class WorkflowTemplateServiceBlockingStub
Expand Down Expand Up @@ -1037,7 +1037,7 @@ public com.google.protobuf.Empty deleteWorkflowTemplate(
*
* <pre>
* The API interface for managing Workflow Templates in the
* Cloud Dataproc API.
* Dataproc API.
* </pre>
*/
public static final class WorkflowTemplateServiceFutureStub
Expand Down
Expand Up @@ -131,7 +131,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
* * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `nvidia-tesla-k80`
* **Auto Zone Exception**: If you are using the Cloud Dataproc
* **Auto Zone Exception**: If you are using the Dataproc
* [Auto Zone
* Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
* feature, you must use the short name of the accelerator type
Expand Down Expand Up @@ -165,7 +165,7 @@ public java.lang.String getAcceleratorTypeUri() {
* * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `nvidia-tesla-k80`
* **Auto Zone Exception**: If you are using the Cloud Dataproc
* **Auto Zone Exception**: If you are using the Dataproc
* [Auto Zone
* Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
* feature, you must use the short name of the accelerator type
Expand Down Expand Up @@ -550,7 +550,7 @@ public Builder mergeFrom(
* * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `nvidia-tesla-k80`
* **Auto Zone Exception**: If you are using the Cloud Dataproc
* **Auto Zone Exception**: If you are using the Dataproc
* [Auto Zone
* Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
* feature, you must use the short name of the accelerator type
Expand Down Expand Up @@ -584,7 +584,7 @@ public java.lang.String getAcceleratorTypeUri() {
* * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `nvidia-tesla-k80`
* **Auto Zone Exception**: If you are using the Cloud Dataproc
* **Auto Zone Exception**: If you are using the Dataproc
* [Auto Zone
* Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
* feature, you must use the short name of the accelerator type
Expand Down Expand Up @@ -618,7 +618,7 @@ public com.google.protobuf.ByteString getAcceleratorTypeUriBytes() {
* * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `nvidia-tesla-k80`
* **Auto Zone Exception**: If you are using the Cloud Dataproc
* **Auto Zone Exception**: If you are using the Dataproc
* [Auto Zone
* Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
* feature, you must use the short name of the accelerator type
Expand Down Expand Up @@ -651,7 +651,7 @@ public Builder setAcceleratorTypeUri(java.lang.String value) {
* * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `nvidia-tesla-k80`
* **Auto Zone Exception**: If you are using the Cloud Dataproc
* **Auto Zone Exception**: If you are using the Dataproc
* [Auto Zone
* Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
* feature, you must use the short name of the accelerator type
Expand Down Expand Up @@ -680,7 +680,7 @@ public Builder clearAcceleratorTypeUri() {
* * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `nvidia-tesla-k80`
* **Auto Zone Exception**: If you are using the Cloud Dataproc
* **Auto Zone Exception**: If you are using the Dataproc
* [Auto Zone
* Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
* feature, you must use the short name of the accelerator type
Expand Down
Expand Up @@ -35,7 +35,7 @@ public interface AcceleratorConfigOrBuilder
* * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `nvidia-tesla-k80`
* **Auto Zone Exception**: If you are using the Cloud Dataproc
* **Auto Zone Exception**: If you are using the Dataproc
* [Auto Zone
* Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
* feature, you must use the short name of the accelerator type
Expand All @@ -59,7 +59,7 @@ public interface AcceleratorConfigOrBuilder
* * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
* * `nvidia-tesla-k80`
* **Auto Zone Exception**: If you are using the Cloud Dataproc
* **Auto Zone Exception**: If you are using the Dataproc
* [Auto Zone
* Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
* feature, you must use the short name of the accelerator type
Expand Down
Expand Up @@ -122,7 +122,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
* Examples:
* * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* * `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* Note that the policy must be in the same project and Cloud Dataproc region.
* Note that the policy must be in the same project and Dataproc region.
* </pre>
*
* <code>string policy_uri = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -149,7 +149,7 @@ public java.lang.String getPolicyUri() {
* Examples:
* * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* * `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* Note that the policy must be in the same project and Cloud Dataproc region.
* Note that the policy must be in the same project and Dataproc region.
* </pre>
*
* <code>string policy_uri = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand Down Expand Up @@ -494,7 +494,7 @@ public Builder mergeFrom(
* Examples:
* * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* * `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* Note that the policy must be in the same project and Cloud Dataproc region.
* Note that the policy must be in the same project and Dataproc region.
* </pre>
*
* <code>string policy_uri = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -521,7 +521,7 @@ public java.lang.String getPolicyUri() {
* Examples:
* * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* * `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* Note that the policy must be in the same project and Cloud Dataproc region.
* Note that the policy must be in the same project and Dataproc region.
* </pre>
*
* <code>string policy_uri = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -548,7 +548,7 @@ public com.google.protobuf.ByteString getPolicyUriBytes() {
* Examples:
* * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* * `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* Note that the policy must be in the same project and Cloud Dataproc region.
* Note that the policy must be in the same project and Dataproc region.
* </pre>
*
* <code>string policy_uri = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -574,7 +574,7 @@ public Builder setPolicyUri(java.lang.String value) {
* Examples:
* * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* * `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* Note that the policy must be in the same project and Cloud Dataproc region.
* Note that the policy must be in the same project and Dataproc region.
* </pre>
*
* <code>string policy_uri = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -596,7 +596,7 @@ public Builder clearPolicyUri() {
* Examples:
* * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* * `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]`
* Note that the policy must be in the same project and Cloud Dataproc region.
* Note that the policy must be in the same project and Dataproc region.
* </pre>
*
* <code>string policy_uri = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand Down