com.google.cloud.devtools.cloudbuild.v1

Class CloudBuildSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<CloudBuildSettings>

com.google.cloud.devtools.cloudbuild.v1.CloudBuildSettings

@Generated(value="by gapic-generator-java")
public class CloudBuildSettings
extends com.google.api.gax.rpc.ClientSettings<CloudBuildSettings>

Settings class to configure an instance of CloudBuildClient.

The default instance has everything set to sensible defaults:

• The default service address (cloudbuild.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getBuild to 30 seconds:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CloudBuildSettings.Builder cloudBuildSettingsBuilder = CloudBuildSettings.newBuilder();
 cloudBuildSettingsBuilder
     .getBuildSettings()
     .setRetrySettings(
         cloudBuildSettingsBuilder
             .getBuildSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudBuildSettings cloudBuildSettings = cloudBuildSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudBuildSettings.Builder Builder for CloudBuildSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudBuildSettings(CloudBuildSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<ApproveBuildRequest,Build,BuildOperationMetadata>	approveBuildOperationSettings() Returns the object with the settings used for calls to approveBuild.
com.google.api.gax.rpc.UnaryCallSettings<ApproveBuildRequest,com.google.longrunning.Operation>	approveBuildSettings() Returns the object with the settings used for calls to approveBuild.
com.google.api.gax.rpc.UnaryCallSettings<CancelBuildRequest,Build>	cancelBuildSettings() Returns the object with the settings used for calls to cancelBuild.
static CloudBuildSettings	create(CloudBuildStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateBuildRequest,Build,BuildOperationMetadata>	createBuildOperationSettings() Returns the object with the settings used for calls to createBuild.
com.google.api.gax.rpc.UnaryCallSettings<CreateBuildRequest,com.google.longrunning.Operation>	createBuildSettings() Returns the object with the settings used for calls to createBuild.
com.google.api.gax.rpc.UnaryCallSettings<CreateBuildTriggerRequest,BuildTrigger>	createBuildTriggerSettings() Returns the object with the settings used for calls to createBuildTrigger.
com.google.api.gax.rpc.OperationCallSettings<CreateWorkerPoolRequest,WorkerPool,CreateWorkerPoolOperationMetadata>	createWorkerPoolOperationSettings() Returns the object with the settings used for calls to createWorkerPool.
com.google.api.gax.rpc.UnaryCallSettings<CreateWorkerPoolRequest,com.google.longrunning.Operation>	createWorkerPoolSettings() Returns the object with the settings used for calls to createWorkerPool.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteBuildTriggerRequest,com.google.protobuf.Empty>	deleteBuildTriggerSettings() Returns the object with the settings used for calls to deleteBuildTrigger.
com.google.api.gax.rpc.OperationCallSettings<DeleteWorkerPoolRequest,com.google.protobuf.Empty,DeleteWorkerPoolOperationMetadata>	deleteWorkerPoolOperationSettings() Returns the object with the settings used for calls to deleteWorkerPool.
com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkerPoolRequest,com.google.longrunning.Operation>	deleteWorkerPoolSettings() Returns the object with the settings used for calls to deleteWorkerPool.
com.google.api.gax.rpc.UnaryCallSettings<GetBuildRequest,Build>	getBuildSettings() Returns the object with the settings used for calls to getBuild.
com.google.api.gax.rpc.UnaryCallSettings<GetBuildTriggerRequest,BuildTrigger>	getBuildTriggerSettings() Returns the object with the settings used for calls to getBuildTrigger.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetWorkerPoolRequest,WorkerPool>	getWorkerPoolSettings() Returns the object with the settings used for calls to getWorkerPool.
com.google.api.gax.rpc.PagedCallSettings<ListBuildsRequest,ListBuildsResponse,CloudBuildClient.ListBuildsPagedResponse>	listBuildsSettings() Returns the object with the settings used for calls to listBuilds.
com.google.api.gax.rpc.PagedCallSettings<ListBuildTriggersRequest,ListBuildTriggersResponse,CloudBuildClient.ListBuildTriggersPagedResponse>	listBuildTriggersSettings() Returns the object with the settings used for calls to listBuildTriggers.
com.google.api.gax.rpc.PagedCallSettings<ListWorkerPoolsRequest,ListWorkerPoolsResponse,CloudBuildClient.ListWorkerPoolsPagedResponse>	listWorkerPoolsSettings() Returns the object with the settings used for calls to listWorkerPools.
static CloudBuildSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static CloudBuildSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static CloudBuildSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<ReceiveTriggerWebhookRequest,ReceiveTriggerWebhookResponse>	receiveTriggerWebhookSettings() Returns the object with the settings used for calls to receiveTriggerWebhook.
com.google.api.gax.rpc.OperationCallSettings<RetryBuildRequest,Build,BuildOperationMetadata>	retryBuildOperationSettings() Returns the object with the settings used for calls to retryBuild.
com.google.api.gax.rpc.UnaryCallSettings<RetryBuildRequest,com.google.longrunning.Operation>	retryBuildSettings() Returns the object with the settings used for calls to retryBuild.
com.google.api.gax.rpc.OperationCallSettings<RunBuildTriggerRequest,Build,BuildOperationMetadata>	runBuildTriggerOperationSettings() Returns the object with the settings used for calls to runBuildTrigger.
com.google.api.gax.rpc.UnaryCallSettings<RunBuildTriggerRequest,com.google.longrunning.Operation>	runBuildTriggerSettings() Returns the object with the settings used for calls to runBuildTrigger.
CloudBuildSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateBuildTriggerRequest,BuildTrigger>	updateBuildTriggerSettings() Returns the object with the settings used for calls to updateBuildTrigger.
com.google.api.gax.rpc.OperationCallSettings<UpdateWorkerPoolRequest,WorkerPool,UpdateWorkerPoolOperationMetadata>	updateWorkerPoolOperationSettings() Returns the object with the settings used for calls to updateWorkerPool.
com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkerPoolRequest,com.google.longrunning.Operation>	updateWorkerPoolSettings() Returns the object with the settings used for calls to updateWorkerPool.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CloudBuildSettings

protected CloudBuildSettings(CloudBuildSettings.Builder settingsBuilder)
                      throws IOException

Throws:

IOException

Method Detail

createBuildSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateBuildRequest,com.google.longrunning.Operation> createBuildSettings()

Returns the object with the settings used for calls to createBuild.

createBuildOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateBuildRequest,Build,BuildOperationMetadata> createBuildOperationSettings()

Returns the object with the settings used for calls to createBuild.

getBuildSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetBuildRequest,Build> getBuildSettings()

Returns the object with the settings used for calls to getBuild.

listBuildsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListBuildsRequest,ListBuildsResponse,CloudBuildClient.ListBuildsPagedResponse> listBuildsSettings()

Returns the object with the settings used for calls to listBuilds.

cancelBuildSettings

public com.google.api.gax.rpc.UnaryCallSettings<CancelBuildRequest,Build> cancelBuildSettings()

Returns the object with the settings used for calls to cancelBuild.

retryBuildSettings

public com.google.api.gax.rpc.UnaryCallSettings<RetryBuildRequest,com.google.longrunning.Operation> retryBuildSettings()

Returns the object with the settings used for calls to retryBuild.

retryBuildOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RetryBuildRequest,Build,BuildOperationMetadata> retryBuildOperationSettings()

Returns the object with the settings used for calls to retryBuild.

approveBuildSettings

public com.google.api.gax.rpc.UnaryCallSettings<ApproveBuildRequest,com.google.longrunning.Operation> approveBuildSettings()

Returns the object with the settings used for calls to approveBuild.

approveBuildOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ApproveBuildRequest,Build,BuildOperationMetadata> approveBuildOperationSettings()

Returns the object with the settings used for calls to approveBuild.

createBuildTriggerSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateBuildTriggerRequest,BuildTrigger> createBuildTriggerSettings()

Returns the object with the settings used for calls to createBuildTrigger.

getBuildTriggerSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetBuildTriggerRequest,BuildTrigger> getBuildTriggerSettings()

Returns the object with the settings used for calls to getBuildTrigger.

listBuildTriggersSettings

public com.google.api.gax.rpc.PagedCallSettings<ListBuildTriggersRequest,ListBuildTriggersResponse,CloudBuildClient.ListBuildTriggersPagedResponse> listBuildTriggersSettings()

Returns the object with the settings used for calls to listBuildTriggers.

deleteBuildTriggerSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteBuildTriggerRequest,com.google.protobuf.Empty> deleteBuildTriggerSettings()

Returns the object with the settings used for calls to deleteBuildTrigger.

updateBuildTriggerSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateBuildTriggerRequest,BuildTrigger> updateBuildTriggerSettings()

Returns the object with the settings used for calls to updateBuildTrigger.

runBuildTriggerSettings

public com.google.api.gax.rpc.UnaryCallSettings<RunBuildTriggerRequest,com.google.longrunning.Operation> runBuildTriggerSettings()

Returns the object with the settings used for calls to runBuildTrigger.

runBuildTriggerOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RunBuildTriggerRequest,Build,BuildOperationMetadata> runBuildTriggerOperationSettings()

Returns the object with the settings used for calls to runBuildTrigger.

receiveTriggerWebhookSettings

public com.google.api.gax.rpc.UnaryCallSettings<ReceiveTriggerWebhookRequest,ReceiveTriggerWebhookResponse> receiveTriggerWebhookSettings()

Returns the object with the settings used for calls to receiveTriggerWebhook.

createWorkerPoolSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateWorkerPoolRequest,com.google.longrunning.Operation> createWorkerPoolSettings()

Returns the object with the settings used for calls to createWorkerPool.

createWorkerPoolOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateWorkerPoolRequest,WorkerPool,CreateWorkerPoolOperationMetadata> createWorkerPoolOperationSettings()

Returns the object with the settings used for calls to createWorkerPool.

getWorkerPoolSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetWorkerPoolRequest,WorkerPool> getWorkerPoolSettings()

Returns the object with the settings used for calls to getWorkerPool.

deleteWorkerPoolSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkerPoolRequest,com.google.longrunning.Operation> deleteWorkerPoolSettings()

Returns the object with the settings used for calls to deleteWorkerPool.

deleteWorkerPoolOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteWorkerPoolRequest,com.google.protobuf.Empty,DeleteWorkerPoolOperationMetadata> deleteWorkerPoolOperationSettings()

Returns the object with the settings used for calls to deleteWorkerPool.

updateWorkerPoolSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkerPoolRequest,com.google.longrunning.Operation> updateWorkerPoolSettings()

Returns the object with the settings used for calls to updateWorkerPool.

updateWorkerPoolOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateWorkerPoolRequest,WorkerPool,UpdateWorkerPoolOperationMetadata> updateWorkerPoolOperationSettings()

Returns the object with the settings used for calls to updateWorkerPool.

listWorkerPoolsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListWorkerPoolsRequest,ListWorkerPoolsResponse,CloudBuildClient.ListWorkerPoolsPagedResponse> listWorkerPoolsSettings()

Returns the object with the settings used for calls to listWorkerPools.

create

public static final CloudBuildSettings create(CloudBuildStubSettings stub)
                                       throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static CloudBuildSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static CloudBuildSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static CloudBuildSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public CloudBuildSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<CloudBuildSettings>