Package com.google.cloud.iot.v1.stub
Class DeviceManagerStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<DeviceManagerStubSettings>
com.google.cloud.iot.v1.stub.DeviceManagerStubSettings
@Generated("by gapic-generator-java")
public class DeviceManagerStubSettings
extends StubSettings<DeviceManagerStubSettings>
Settings class to configure an instance of
DeviceManagerStub.
The default instance has everything set to sensible defaults:
- The default service address (cloudiot.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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of createDeviceRegistry:
// 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
DeviceManagerStubSettings.Builder deviceManagerSettingsBuilder =
DeviceManagerStubSettings.newBuilder();
deviceManagerSettingsBuilder
.createDeviceRegistrySettings()
.setRetrySettings(
deviceManagerSettingsBuilder
.createDeviceRegistrySettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
DeviceManagerStubSettings deviceManagerSettings = deviceManagerSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for DeviceManagerStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDeviceManagerStubSettings(DeviceManagerStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to bindDeviceToGateway.Returns the object with the settings used for calls to createDeviceRegistry.Returns the object with the settings used for calls to createDevice.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteDeviceRegistryRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteDeviceRegistry.UnaryCallSettings<DeleteDeviceRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteDevice.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getDeviceRegistry.Returns the object with the settings used for calls to getDevice.Returns the object with the settings used for calls to getIamPolicy.protected LibraryMetadataReturns the default service name.Returns the object with the settings used for calls to listDeviceConfigVersions.PagedCallSettings<ListDeviceRegistriesRequest,ListDeviceRegistriesResponse, DeviceManagerClient.ListDeviceRegistriesPagedResponse> Returns the object with the settings used for calls to listDeviceRegistries.PagedCallSettings<ListDevicesRequest,ListDevicesResponse, DeviceManagerClient.ListDevicesPagedResponse> Returns the object with the settings used for calls to listDevices.Returns the object with the settings used for calls to listDeviceStates.Returns the object with the settings used for calls to modifyCloudToDeviceConfig.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to sendCommandToDevice.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to unbindDeviceFromGateway.Returns the object with the settings used for calls to updateDeviceRegistry.Returns the object with the settings used for calls to updateDevice.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
DeviceManagerStubSettings
protected DeviceManagerStubSettings(DeviceManagerStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createDeviceRegistrySettings
Returns the object with the settings used for calls to createDeviceRegistry. -
getDeviceRegistrySettings
Returns the object with the settings used for calls to getDeviceRegistry. -
updateDeviceRegistrySettings
Returns the object with the settings used for calls to updateDeviceRegistry. -
deleteDeviceRegistrySettings
public UnaryCallSettings<DeleteDeviceRegistryRequest,com.google.protobuf.Empty> deleteDeviceRegistrySettings()Returns the object with the settings used for calls to deleteDeviceRegistry. -
listDeviceRegistriesSettings
public PagedCallSettings<ListDeviceRegistriesRequest,ListDeviceRegistriesResponse, listDeviceRegistriesSettings()DeviceManagerClient.ListDeviceRegistriesPagedResponse> Returns the object with the settings used for calls to listDeviceRegistries. -
createDeviceSettings
Returns the object with the settings used for calls to createDevice. -
getDeviceSettings
Returns the object with the settings used for calls to getDevice. -
updateDeviceSettings
Returns the object with the settings used for calls to updateDevice. -
deleteDeviceSettings
Returns the object with the settings used for calls to deleteDevice. -
listDevicesSettings
public PagedCallSettings<ListDevicesRequest,ListDevicesResponse, listDevicesSettings()DeviceManagerClient.ListDevicesPagedResponse> Returns the object with the settings used for calls to listDevices. -
modifyCloudToDeviceConfigSettings
public UnaryCallSettings<ModifyCloudToDeviceConfigRequest,DeviceConfig> modifyCloudToDeviceConfigSettings()Returns the object with the settings used for calls to modifyCloudToDeviceConfig. -
listDeviceConfigVersionsSettings
public UnaryCallSettings<ListDeviceConfigVersionsRequest,ListDeviceConfigVersionsResponse> listDeviceConfigVersionsSettings()Returns the object with the settings used for calls to listDeviceConfigVersions. -
listDeviceStatesSettings
public UnaryCallSettings<ListDeviceStatesRequest,ListDeviceStatesResponse> listDeviceStatesSettings()Returns the object with the settings used for calls to listDeviceStates. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
sendCommandToDeviceSettings
public UnaryCallSettings<SendCommandToDeviceRequest,SendCommandToDeviceResponse> sendCommandToDeviceSettings()Returns the object with the settings used for calls to sendCommandToDevice. -
bindDeviceToGatewaySettings
public UnaryCallSettings<BindDeviceToGatewayRequest,BindDeviceToGatewayResponse> bindDeviceToGatewaySettings()Returns the object with the settings used for calls to bindDeviceToGateway. -
unbindDeviceFromGatewaySettings
public UnaryCallSettings<UnbindDeviceFromGatewayRequest,UnbindDeviceFromGatewayResponse> unbindDeviceFromGatewaySettings()Returns the object with the settings used for calls to unbindDeviceFromGateway. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<DeviceManagerStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<DeviceManagerStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<DeviceManagerStubSettings>
-