Class CloudBuildStubSettings (3.37.0)

public class CloudBuildStubSettings extends StubSettings<CloudBuildStubSettings>

Settings class to configure an instance of CloudBuildStub.

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
 CloudBuildStubSettings.Builder cloudBuildSettingsBuilder = CloudBuildStubSettings.newBuilder();
 cloudBuildSettingsBuilder
     .getBuildSettings()
     .setRetrySettings(
         cloudBuildSettingsBuilder
             .getBuildSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudBuildStubSettings cloudBuildSettings = cloudBuildSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > CloudBuildStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
`Builder`

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
`Builder`

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
Type	Description
`Builder`

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
Type	Description
`Builder`

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
`TransportChannelProvider`

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
`String`

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type	Description
`String`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
`List<String>`

newBuilder()

public static CloudBuildStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`CloudBuildStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static CloudBuildStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`CloudBuildStubSettings.Builder`

newHttpJsonBuilder()

public static CloudBuildStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`CloudBuildStubSettings.Builder`

Constructors

CloudBuildStubSettings(CloudBuildStubSettings.Builder settingsBuilder)

protected CloudBuildStubSettings(CloudBuildStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`CloudBuildStubSettings.Builder`

Methods

approveBuildOperationSettings()

public OperationCallSettings<ApproveBuildRequest,Build,BuildOperationMetadata> approveBuildOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<ApproveBuildRequest,Build,BuildOperationMetadata>`

approveBuildSettings()

public UnaryCallSettings<ApproveBuildRequest,Operation> approveBuildSettings()

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

Returns
Type	Description
`UnaryCallSettings<ApproveBuildRequest,Operation>`

cancelBuildSettings()

public UnaryCallSettings<CancelBuildRequest,Build> cancelBuildSettings()

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

Returns
Type	Description
`UnaryCallSettings<CancelBuildRequest,Build>`

createBuildOperationSettings()

public OperationCallSettings<CreateBuildRequest,Build,BuildOperationMetadata> createBuildOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateBuildRequest,Build,BuildOperationMetadata>`

createBuildSettings()

public UnaryCallSettings<CreateBuildRequest,Operation> createBuildSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateBuildRequest,Operation>`

createBuildTriggerSettings()

public UnaryCallSettings<CreateBuildTriggerRequest,BuildTrigger> createBuildTriggerSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateBuildTriggerRequest,BuildTrigger>`

createStub()

public CloudBuildStub createStub()

Returns
Type	Description
`CloudBuildStub`

Exceptions
Type	Description
`IOException`

createWorkerPoolOperationSettings()

public OperationCallSettings<CreateWorkerPoolRequest,WorkerPool,CreateWorkerPoolOperationMetadata> createWorkerPoolOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateWorkerPoolRequest,WorkerPool,CreateWorkerPoolOperationMetadata>`

createWorkerPoolSettings()

public UnaryCallSettings<CreateWorkerPoolRequest,Operation> createWorkerPoolSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateWorkerPoolRequest,Operation>`

deleteBuildTriggerSettings()

public UnaryCallSettings<DeleteBuildTriggerRequest,Empty> deleteBuildTriggerSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteBuildTriggerRequest,Empty>`

deleteWorkerPoolOperationSettings()

public OperationCallSettings<DeleteWorkerPoolRequest,Empty,DeleteWorkerPoolOperationMetadata> deleteWorkerPoolOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteWorkerPoolRequest,Empty,DeleteWorkerPoolOperationMetadata>`

deleteWorkerPoolSettings()

public UnaryCallSettings<DeleteWorkerPoolRequest,Operation> deleteWorkerPoolSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteWorkerPoolRequest,Operation>`

getBuildSettings()

public UnaryCallSettings<GetBuildRequest,Build> getBuildSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetBuildRequest,Build>`

getBuildTriggerSettings()

public UnaryCallSettings<GetBuildTriggerRequest,BuildTrigger> getBuildTriggerSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetBuildTriggerRequest,BuildTrigger>`

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getEndpoint()

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

getWorkerPoolSettings()

public UnaryCallSettings<GetWorkerPoolRequest,WorkerPool> getWorkerPoolSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetWorkerPoolRequest,WorkerPool>`

listBuildTriggersSettings()

public PagedCallSettings<ListBuildTriggersRequest,ListBuildTriggersResponse,CloudBuildClient.ListBuildTriggersPagedResponse> listBuildTriggersSettings()

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

Returns
Type	Description
`PagedCallSettings<ListBuildTriggersRequest,ListBuildTriggersResponse,ListBuildTriggersPagedResponse>`

listBuildsSettings()

public PagedCallSettings<ListBuildsRequest,ListBuildsResponse,CloudBuildClient.ListBuildsPagedResponse> listBuildsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListBuildsRequest,ListBuildsResponse,ListBuildsPagedResponse>`

listWorkerPoolsSettings()

public PagedCallSettings<ListWorkerPoolsRequest,ListWorkerPoolsResponse,CloudBuildClient.ListWorkerPoolsPagedResponse> listWorkerPoolsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListWorkerPoolsRequest,ListWorkerPoolsResponse,ListWorkerPoolsPagedResponse>`

receiveTriggerWebhookSettings()

public UnaryCallSettings<ReceiveTriggerWebhookRequest,ReceiveTriggerWebhookResponse> receiveTriggerWebhookSettings()

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

Returns
Type	Description
`UnaryCallSettings<ReceiveTriggerWebhookRequest,ReceiveTriggerWebhookResponse>`

retryBuildOperationSettings()

public OperationCallSettings<RetryBuildRequest,Build,BuildOperationMetadata> retryBuildOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<RetryBuildRequest,Build,BuildOperationMetadata>`

retryBuildSettings()

public UnaryCallSettings<RetryBuildRequest,Operation> retryBuildSettings()

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

Returns
Type	Description
`UnaryCallSettings<RetryBuildRequest,Operation>`

runBuildTriggerOperationSettings()

public OperationCallSettings<RunBuildTriggerRequest,Build,BuildOperationMetadata> runBuildTriggerOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<RunBuildTriggerRequest,Build,BuildOperationMetadata>`

runBuildTriggerSettings()

public UnaryCallSettings<RunBuildTriggerRequest,Operation> runBuildTriggerSettings()

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

Returns
Type	Description
`UnaryCallSettings<RunBuildTriggerRequest,Operation>`

toBuilder()

public CloudBuildStubSettings.Builder toBuilder()

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

Returns
Type	Description
`CloudBuildStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateBuildTriggerSettings()

public UnaryCallSettings<UpdateBuildTriggerRequest,BuildTrigger> updateBuildTriggerSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateBuildTriggerRequest,BuildTrigger>`

updateWorkerPoolOperationSettings()

public OperationCallSettings<UpdateWorkerPoolRequest,WorkerPool,UpdateWorkerPoolOperationMetadata> updateWorkerPoolOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateWorkerPoolRequest,WorkerPool,UpdateWorkerPoolOperationMetadata>`

updateWorkerPoolSettings()

public UnaryCallSettings<UpdateWorkerPoolRequest,Operation> updateWorkerPoolSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateWorkerPoolRequest,Operation>`