Class AppHubSettings (0.3.0)

public class AppHubSettings extends ClientSettings<AppHubSettings>

Settings class to configure an instance of AppHubClient.

The default instance has everything set to sensible defaults:

  • The default service address (apphub.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 lookupServiceProjectAttachment 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
 AppHubSettings.Builder appHubSettingsBuilder = AppHubSettings.newBuilder();
 appHubSettingsBuilder
     .lookupServiceProjectAttachmentSettings()
     .setRetrySettings(
         appHubSettingsBuilder
             .lookupServiceProjectAttachmentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AppHubSettings appHubSettings = appHubSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > AppHubSettings

Static Methods

create(AppHubStubSettings stub)

public static final AppHubSettings create(AppHubStubSettings stub)
Parameter
NameDescription
stubAppHubStubSettings
Returns
TypeDescription
AppHubSettings
Exceptions
TypeDescription
IOException

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static AppHubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
AppHubSettings.Builder

newBuilder(ClientContext clientContext)

public static AppHubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
AppHubSettings.Builder

newHttpJsonBuilder()

public static AppHubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
AppHubSettings.Builder

Constructors

AppHubSettings(AppHubSettings.Builder settingsBuilder)

protected AppHubSettings(AppHubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderAppHubSettings.Builder

Methods

createApplicationOperationSettings()

public OperationCallSettings<CreateApplicationRequest,Application,OperationMetadata> createApplicationOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateApplicationRequest,Application,OperationMetadata>

createApplicationSettings()

public UnaryCallSettings<CreateApplicationRequest,Operation> createApplicationSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateApplicationRequest,Operation>

createServiceOperationSettings()

public OperationCallSettings<CreateServiceRequest,Service,OperationMetadata> createServiceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateServiceRequest,Service,OperationMetadata>

createServiceProjectAttachmentOperationSettings()

public OperationCallSettings<CreateServiceProjectAttachmentRequest,ServiceProjectAttachment,OperationMetadata> createServiceProjectAttachmentOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateServiceProjectAttachmentRequest,ServiceProjectAttachment,OperationMetadata>

createServiceProjectAttachmentSettings()

public UnaryCallSettings<CreateServiceProjectAttachmentRequest,Operation> createServiceProjectAttachmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateServiceProjectAttachmentRequest,Operation>

createServiceSettings()

public UnaryCallSettings<CreateServiceRequest,Operation> createServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateServiceRequest,Operation>

createWorkloadOperationSettings()

public OperationCallSettings<CreateWorkloadRequest,Workload,OperationMetadata> createWorkloadOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateWorkloadRequest,Workload,OperationMetadata>

createWorkloadSettings()

public UnaryCallSettings<CreateWorkloadRequest,Operation> createWorkloadSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateWorkloadRequest,Operation>

deleteApplicationOperationSettings()

public OperationCallSettings<DeleteApplicationRequest,Empty,OperationMetadata> deleteApplicationOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteApplicationRequest,Empty,OperationMetadata>

deleteApplicationSettings()

public UnaryCallSettings<DeleteApplicationRequest,Operation> deleteApplicationSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteApplicationRequest,Operation>

deleteServiceOperationSettings()

public OperationCallSettings<DeleteServiceRequest,Empty,OperationMetadata> deleteServiceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteServiceRequest,Empty,OperationMetadata>

deleteServiceProjectAttachmentOperationSettings()

public OperationCallSettings<DeleteServiceProjectAttachmentRequest,Empty,OperationMetadata> deleteServiceProjectAttachmentOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteServiceProjectAttachmentRequest,Empty,OperationMetadata>

deleteServiceProjectAttachmentSettings()

public UnaryCallSettings<DeleteServiceProjectAttachmentRequest,Operation> deleteServiceProjectAttachmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteServiceProjectAttachmentRequest,Operation>

deleteServiceSettings()

public UnaryCallSettings<DeleteServiceRequest,Operation> deleteServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteServiceRequest,Operation>

deleteWorkloadOperationSettings()

public OperationCallSettings<DeleteWorkloadRequest,Empty,OperationMetadata> deleteWorkloadOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteWorkloadRequest,Empty,OperationMetadata>

deleteWorkloadSettings()

public UnaryCallSettings<DeleteWorkloadRequest,Operation> deleteWorkloadSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteWorkloadRequest,Operation>

detachServiceProjectAttachmentSettings()

public UnaryCallSettings<DetachServiceProjectAttachmentRequest,DetachServiceProjectAttachmentResponse> detachServiceProjectAttachmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<DetachServiceProjectAttachmentRequest,DetachServiceProjectAttachmentResponse>

getApplicationSettings()

public UnaryCallSettings<GetApplicationRequest,Application> getApplicationSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetApplicationRequest,Application>

getDiscoveredServiceSettings()

public UnaryCallSettings<GetDiscoveredServiceRequest,DiscoveredService> getDiscoveredServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDiscoveredServiceRequest,DiscoveredService>

getDiscoveredWorkloadSettings()

public UnaryCallSettings<GetDiscoveredWorkloadRequest,DiscoveredWorkload> getDiscoveredWorkloadSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDiscoveredWorkloadRequest,DiscoveredWorkload>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getServiceProjectAttachmentSettings()

public UnaryCallSettings<GetServiceProjectAttachmentRequest,ServiceProjectAttachment> getServiceProjectAttachmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetServiceProjectAttachmentRequest,ServiceProjectAttachment>

getServiceSettings()

public UnaryCallSettings<GetServiceRequest,Service> getServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetServiceRequest,Service>

getWorkloadSettings()

public UnaryCallSettings<GetWorkloadRequest,Workload> getWorkloadSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetWorkloadRequest,Workload>

listApplicationsSettings()

public PagedCallSettings<ListApplicationsRequest,ListApplicationsResponse,AppHubClient.ListApplicationsPagedResponse> listApplicationsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListApplicationsRequest,ListApplicationsResponse,ListApplicationsPagedResponse>

listDiscoveredServicesSettings()

public PagedCallSettings<ListDiscoveredServicesRequest,ListDiscoveredServicesResponse,AppHubClient.ListDiscoveredServicesPagedResponse> listDiscoveredServicesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListDiscoveredServicesRequest,ListDiscoveredServicesResponse,ListDiscoveredServicesPagedResponse>

listDiscoveredWorkloadsSettings()

public PagedCallSettings<ListDiscoveredWorkloadsRequest,ListDiscoveredWorkloadsResponse,AppHubClient.ListDiscoveredWorkloadsPagedResponse> listDiscoveredWorkloadsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListDiscoveredWorkloadsRequest,ListDiscoveredWorkloadsResponse,ListDiscoveredWorkloadsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,AppHubClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
TypeDescription
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listServiceProjectAttachmentsSettings()

public PagedCallSettings<ListServiceProjectAttachmentsRequest,ListServiceProjectAttachmentsResponse,AppHubClient.ListServiceProjectAttachmentsPagedResponse> listServiceProjectAttachmentsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListServiceProjectAttachmentsRequest,ListServiceProjectAttachmentsResponse,ListServiceProjectAttachmentsPagedResponse>

listServicesSettings()

public PagedCallSettings<ListServicesRequest,ListServicesResponse,AppHubClient.ListServicesPagedResponse> listServicesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListServicesRequest,ListServicesResponse,ListServicesPagedResponse>

listWorkloadsSettings()

public PagedCallSettings<ListWorkloadsRequest,ListWorkloadsResponse,AppHubClient.ListWorkloadsPagedResponse> listWorkloadsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListWorkloadsRequest,ListWorkloadsResponse,ListWorkloadsPagedResponse>

lookupDiscoveredServiceSettings()

public UnaryCallSettings<LookupDiscoveredServiceRequest,LookupDiscoveredServiceResponse> lookupDiscoveredServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<LookupDiscoveredServiceRequest,LookupDiscoveredServiceResponse>

lookupDiscoveredWorkloadSettings()

public UnaryCallSettings<LookupDiscoveredWorkloadRequest,LookupDiscoveredWorkloadResponse> lookupDiscoveredWorkloadSettings()

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

Returns
TypeDescription
UnaryCallSettings<LookupDiscoveredWorkloadRequest,LookupDiscoveredWorkloadResponse>

lookupServiceProjectAttachmentSettings()

public UnaryCallSettings<LookupServiceProjectAttachmentRequest,LookupServiceProjectAttachmentResponse> lookupServiceProjectAttachmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<LookupServiceProjectAttachmentRequest,LookupServiceProjectAttachmentResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public AppHubSettings.Builder toBuilder()

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

Returns
TypeDescription
AppHubSettings.Builder
Overrides

updateApplicationOperationSettings()

public OperationCallSettings<UpdateApplicationRequest,Application,OperationMetadata> updateApplicationOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateApplicationRequest,Application,OperationMetadata>

updateApplicationSettings()

public UnaryCallSettings<UpdateApplicationRequest,Operation> updateApplicationSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateApplicationRequest,Operation>

updateServiceOperationSettings()

public OperationCallSettings<UpdateServiceRequest,Service,OperationMetadata> updateServiceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateServiceRequest,Service,OperationMetadata>

updateServiceSettings()

public UnaryCallSettings<UpdateServiceRequest,Operation> updateServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateServiceRequest,Operation>

updateWorkloadOperationSettings()

public OperationCallSettings<UpdateWorkloadRequest,Workload,OperationMetadata> updateWorkloadOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateWorkloadRequest,Workload,OperationMetadata>

updateWorkloadSettings()

public UnaryCallSettings<UpdateWorkloadRequest,Operation> updateWorkloadSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateWorkloadRequest,Operation>