Class CloudBuildStubSettings (3.5.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static CloudBuildStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
CloudBuildStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudBuildStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CloudBuildStubSettings.Builder

newHttpJsonBuilder()

public static CloudBuildStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
CloudBuildStubSettings.Builder

Constructors

CloudBuildStubSettings(CloudBuildStubSettings.Builder settingsBuilder)

protected CloudBuildStubSettings(CloudBuildStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCloudBuildStubSettings.Builder

Methods

approveBuildOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ApproveBuildRequest,Build,BuildOperationMetadata>

approveBuildSettings()

public UnaryCallSettings<ApproveBuildRequest,Operation> approveBuildSettings()

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

Returns
TypeDescription
UnaryCallSettings<ApproveBuildRequest,Operation>

cancelBuildSettings()

public UnaryCallSettings<CancelBuildRequest,Build> cancelBuildSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelBuildRequest,Build>

createBuildOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateBuildRequest,Build,BuildOperationMetadata>

createBuildSettings()

public UnaryCallSettings<CreateBuildRequest,Operation> createBuildSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateBuildRequest,Operation>

createBuildTriggerSettings()

public UnaryCallSettings<CreateBuildTriggerRequest,BuildTrigger> createBuildTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateBuildTriggerRequest,BuildTrigger>

createStub()

public CloudBuildStub createStub()
Returns
TypeDescription
CloudBuildStub
Exceptions
TypeDescription
IOException

createWorkerPoolOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateWorkerPoolRequest,WorkerPool,CreateWorkerPoolOperationMetadata>

createWorkerPoolSettings()

public UnaryCallSettings<CreateWorkerPoolRequest,Operation> createWorkerPoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateWorkerPoolRequest,Operation>

deleteBuildTriggerSettings()

public UnaryCallSettings<DeleteBuildTriggerRequest,Empty> deleteBuildTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteBuildTriggerRequest,Empty>

deleteWorkerPoolOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteWorkerPoolRequest,Empty,DeleteWorkerPoolOperationMetadata>

deleteWorkerPoolSettings()

public UnaryCallSettings<DeleteWorkerPoolRequest,Operation> deleteWorkerPoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteWorkerPoolRequest,Operation>

getBuildSettings()

public UnaryCallSettings<GetBuildRequest,Build> getBuildSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBuildRequest,Build>

getBuildTriggerSettings()

public UnaryCallSettings<GetBuildTriggerRequest,BuildTrigger> getBuildTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBuildTriggerRequest,BuildTrigger>

getWorkerPoolSettings()

public UnaryCallSettings<GetWorkerPoolRequest,WorkerPool> getWorkerPoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetWorkerPoolRequest,WorkerPool>

listBuildTriggersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListBuildTriggersRequest,ListBuildTriggersResponse,ListBuildTriggersPagedResponse>

listBuildsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListBuildsRequest,ListBuildsResponse,ListBuildsPagedResponse>

listWorkerPoolsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListWorkerPoolsRequest,ListWorkerPoolsResponse,ListWorkerPoolsPagedResponse>

receiveTriggerWebhookSettings()

public UnaryCallSettings<ReceiveTriggerWebhookRequest,ReceiveTriggerWebhookResponse> receiveTriggerWebhookSettings()

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

Returns
TypeDescription
UnaryCallSettings<ReceiveTriggerWebhookRequest,ReceiveTriggerWebhookResponse>

retryBuildOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<RetryBuildRequest,Build,BuildOperationMetadata>

retryBuildSettings()

public UnaryCallSettings<RetryBuildRequest,Operation> retryBuildSettings()

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

Returns
TypeDescription
UnaryCallSettings<RetryBuildRequest,Operation>

runBuildTriggerOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<RunBuildTriggerRequest,Build,BuildOperationMetadata>

runBuildTriggerSettings()

public UnaryCallSettings<RunBuildTriggerRequest,Operation> runBuildTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<RunBuildTriggerRequest,Operation>

toBuilder()

public CloudBuildStubSettings.Builder toBuilder()

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

Returns
TypeDescription
CloudBuildStubSettings.Builder
Overrides

updateBuildTriggerSettings()

public UnaryCallSettings<UpdateBuildTriggerRequest,BuildTrigger> updateBuildTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateBuildTriggerRequest,BuildTrigger>

updateWorkerPoolOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateWorkerPoolRequest,WorkerPool,UpdateWorkerPoolOperationMetadata>

updateWorkerPoolSettings()

public UnaryCallSettings<UpdateWorkerPoolRequest,Operation> updateWorkerPoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateWorkerPoolRequest,Operation>