Class CompanyServiceSettings

public class CompanyServiceSettings extends ClientSettings<CompanyServiceSettings>

Settings class to configure an instance of CompanyServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (jobs.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 createCompany to 30 seconds:


 CompanyServiceSettings.Builder companyServiceSettingsBuilder =
     CompanyServiceSettings.newBuilder();
 companyServiceSettingsBuilder
     .createCompanySettings()
     .setRetrySettings(
         companyServiceSettingsBuilder
             .createCompanySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CompanyServiceSettings companyServiceSettings = companyServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > CompanyServiceSettings

Constructors

CompanyServiceSettings(CompanyServiceSettings.Builder settingsBuilder)

protected CompanyServiceSettings(CompanyServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCompanyServiceSettings.Builder

Methods

create(CompanyServiceStubSettings stub)

public static final CompanyServiceSettings create(CompanyServiceStubSettings stub)
Parameter
NameDescription
stubCompanyServiceStubSettings
Returns
TypeDescription
CompanyServiceSettings
Exceptions
TypeDescription
IOException

createCompanySettings()

public UnaryCallSettings<CreateCompanyRequest,Company> createCompanySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCompanyRequest,Company>

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 ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteCompanySettings()

public UnaryCallSettings<DeleteCompanyRequest,Empty> deleteCompanySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteCompanyRequest,Empty>

getCompanySettings()

public UnaryCallSettings<GetCompanyRequest,Company> getCompanySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCompanyRequest,Company>

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>

listCompaniesSettings()

public PagedCallSettings<ListCompaniesRequest,ListCompaniesResponse,CompanyServiceClient.ListCompaniesPagedResponse> listCompaniesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListCompaniesRequest,ListCompaniesResponse,ListCompaniesPagedResponse>

newBuilder()

public static CompanyServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
CompanyServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static CompanyServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CompanyServiceSettings.Builder

toBuilder()

public CompanyServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
CompanyServiceSettings.Builder
Overrides

updateCompanySettings()

public UnaryCallSettings<UpdateCompanyRequest,Company> updateCompanySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCompanyRequest,Company>