com.google.api.MethodSettingsOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-common-protos Show documentation
Show all versions of proto-google-common-protos Show documentation
PROTO library for proto-google-common-protos
/*
* Copyright 2024 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/api/client.proto
// Protobuf Java Version: 3.25.5
package com.google.api;
public interface MethodSettingsOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.api.MethodSettings)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The fully qualified name of the method, for which the options below apply.
* This is used to find the method to apply the options.
*
* Example:
*
* publishing:
* method_settings:
* - selector: google.storage.control.v2.StorageControl.CreateFolder
* # method settings for CreateFolder...
*
*
* string selector = 1;
*
* @return The selector.
*/
java.lang.String getSelector();
/**
*
*
*
* The fully qualified name of the method, for which the options below apply.
* This is used to find the method to apply the options.
*
* Example:
*
* publishing:
* method_settings:
* - selector: google.storage.control.v2.StorageControl.CreateFolder
* # method settings for CreateFolder...
*
*
* string selector = 1;
*
* @return The bytes for selector.
*/
com.google.protobuf.ByteString getSelectorBytes();
/**
*
*
*
* Describes settings to use for long-running operations when generating
* API methods for RPCs. Complements RPCs that use the annotations in
* google/longrunning/operations.proto.
*
* Example of a YAML configuration::
*
* publishing:
* method_settings:
* - selector: google.cloud.speech.v2.Speech.BatchRecognize
* long_running:
* initial_poll_delay: 60s # 1 minute
* poll_delay_multiplier: 1.5
* max_poll_delay: 360s # 6 minutes
* total_poll_timeout: 54000s # 90 minutes
*
*
* .google.api.MethodSettings.LongRunning long_running = 2;
*
* @return Whether the longRunning field is set.
*/
boolean hasLongRunning();
/**
*
*
*
* Describes settings to use for long-running operations when generating
* API methods for RPCs. Complements RPCs that use the annotations in
* google/longrunning/operations.proto.
*
* Example of a YAML configuration::
*
* publishing:
* method_settings:
* - selector: google.cloud.speech.v2.Speech.BatchRecognize
* long_running:
* initial_poll_delay: 60s # 1 minute
* poll_delay_multiplier: 1.5
* max_poll_delay: 360s # 6 minutes
* total_poll_timeout: 54000s # 90 minutes
*
*
* .google.api.MethodSettings.LongRunning long_running = 2;
*
* @return The longRunning.
*/
com.google.api.MethodSettings.LongRunning getLongRunning();
/**
*
*
*
* Describes settings to use for long-running operations when generating
* API methods for RPCs. Complements RPCs that use the annotations in
* google/longrunning/operations.proto.
*
* Example of a YAML configuration::
*
* publishing:
* method_settings:
* - selector: google.cloud.speech.v2.Speech.BatchRecognize
* long_running:
* initial_poll_delay: 60s # 1 minute
* poll_delay_multiplier: 1.5
* max_poll_delay: 360s # 6 minutes
* total_poll_timeout: 54000s # 90 minutes
*
*
* .google.api.MethodSettings.LongRunning long_running = 2;
*/
com.google.api.MethodSettings.LongRunningOrBuilder getLongRunningOrBuilder();
/**
*
*
*
* List of top-level fields of the request message, that should be
* automatically populated by the client libraries based on their
* (google.api.field_info).format. Currently supported format: UUID4.
*
* Example of a YAML configuration:
*
* publishing:
* method_settings:
* - selector: google.example.v1.ExampleService.CreateExample
* auto_populated_fields:
* - request_id
*
*
* repeated string auto_populated_fields = 3;
*
* @return A list containing the autoPopulatedFields.
*/
java.util.List getAutoPopulatedFieldsList();
/**
*
*
*
* List of top-level fields of the request message, that should be
* automatically populated by the client libraries based on their
* (google.api.field_info).format. Currently supported format: UUID4.
*
* Example of a YAML configuration:
*
* publishing:
* method_settings:
* - selector: google.example.v1.ExampleService.CreateExample
* auto_populated_fields:
* - request_id
*
*
* repeated string auto_populated_fields = 3;
*
* @return The count of autoPopulatedFields.
*/
int getAutoPopulatedFieldsCount();
/**
*
*
*
* List of top-level fields of the request message, that should be
* automatically populated by the client libraries based on their
* (google.api.field_info).format. Currently supported format: UUID4.
*
* Example of a YAML configuration:
*
* publishing:
* method_settings:
* - selector: google.example.v1.ExampleService.CreateExample
* auto_populated_fields:
* - request_id
*
*
* repeated string auto_populated_fields = 3;
*
* @param index The index of the element to return.
* @return The autoPopulatedFields at the given index.
*/
java.lang.String getAutoPopulatedFields(int index);
/**
*
*
*
* List of top-level fields of the request message, that should be
* automatically populated by the client libraries based on their
* (google.api.field_info).format. Currently supported format: UUID4.
*
* Example of a YAML configuration:
*
* publishing:
* method_settings:
* - selector: google.example.v1.ExampleService.CreateExample
* auto_populated_fields:
* - request_id
*
*
* repeated string auto_populated_fields = 3;
*
* @param index The index of the value to return.
* @return The bytes of the autoPopulatedFields at the given index.
*/
com.google.protobuf.ByteString getAutoPopulatedFieldsBytes(int index);
}