com.google.cloud.bigquery.migration.v2.ListMigrationSubtasksRequestOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/bigquery/migration/v2/migration_service.proto

package com.google.cloud.bigquery.migration.v2;

public interface ListMigrationSubtasksRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.bigquery.migration.v2.ListMigrationSubtasksRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The migration task of the subtasks to list.
   * Example: `projects/123/locations/us/workflows/1234`
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   *    * Required. The migration task of the subtasks to list.
   * Example: `projects/123/locations/us/workflows/1234`
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   *    * Optional. The list of fields to be retrieved.
   * 
   *
   * .google.protobuf.FieldMask read_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the readMask field is set.
   */
  boolean hasReadMask();
  /**
   *
   *
   *    * Optional. The list of fields to be retrieved.
   * 
   *
   * .google.protobuf.FieldMask read_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The readMask.
   */
  com.google.protobuf.FieldMask getReadMask();
  /**
   *
   *
   *    * Optional. The list of fields to be retrieved.
   * 
   *
   * .google.protobuf.FieldMask read_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder();

  /**
   *
   *
   *    * Optional. The maximum number of migration tasks to return. The service may
   * return fewer than this number.
   * 
   *
   * int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The pageSize.
   */
  int getPageSize();

  /**
   *
   *
   *    * Optional. A page token, received from previous `ListMigrationSubtasks`
   * call. Provide this to retrieve the subsequent page.
   * When paginating, all other parameters provided to `ListMigrationSubtasks`
   * must match the call that provided the page token.
   * 
   *
   * string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *
   *
   *    * Optional. A page token, received from previous `ListMigrationSubtasks`
   * call. Provide this to retrieve the subsequent page.
   * When paginating, all other parameters provided to `ListMigrationSubtasks`
   * must match the call that provided the page token.
   * 
   *
   * string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();

  /**
   *
   *
   *    * Optional. The filter to apply. This can be used to get the subtasks of a
   * specific tasks in a workflow, e.g. `migration_task = "ab012"` where
   * `"ab012"` is the task ID (not the name in the named map).
   * 
   *
   * string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The filter.
   */
  java.lang.String getFilter();
  /**
   *
   *
   *    * Optional. The filter to apply. This can be used to get the subtasks of a
   * specific tasks in a workflow, e.g. `migration_task = "ab012"` where
   * `"ab012"` is the task ID (not the name in the named map).
   * 
   *
   * string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for filter.
   */
  com.google.protobuf.ByteString getFilterBytes();
}