Class DeviceManagerSettings (2.1.7)

public class DeviceManagerSettings extends ClientSettings<DeviceManagerSettings>

Settings class to configure an instance of DeviceManagerClient.

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 total timeout of createDeviceRegistry to 30 seconds:


 DeviceManagerSettings.Builder deviceManagerSettingsBuilder = DeviceManagerSettings.newBuilder();
 deviceManagerSettingsBuilder
     .createDeviceRegistrySettings()
     .setRetrySettings(
         deviceManagerSettingsBuilder
             .createDeviceRegistrySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DeviceManagerSettings deviceManagerSettings = deviceManagerSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > DeviceManagerSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(DeviceManagerStubSettings stub)

public static final DeviceManagerSettings create(DeviceManagerStubSettings stub)

Parameter

Name	Description
stub	`DeviceManagerStubSettings`

Returns

Type	Description
DeviceManagerSettings

Exceptions

Type	Description
IOException

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default 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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static DeviceManagerSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
DeviceManagerSettings.Builder

newBuilder(ClientContext clientContext)

public static DeviceManagerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
DeviceManagerSettings.Builder

Constructors

DeviceManagerSettings(DeviceManagerSettings.Builder settingsBuilder)

protected DeviceManagerSettings(DeviceManagerSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`DeviceManagerSettings.Builder`

Methods

bindDeviceToGatewaySettings()

public UnaryCallSettings<BindDeviceToGatewayRequest,BindDeviceToGatewayResponse> bindDeviceToGatewaySettings()

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

Returns

Type	Description
UnaryCallSettings<BindDeviceToGatewayRequest,BindDeviceToGatewayResponse>

createDeviceRegistrySettings()

public UnaryCallSettings<CreateDeviceRegistryRequest,DeviceRegistry> createDeviceRegistrySettings()

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

Returns

Type	Description
UnaryCallSettings<CreateDeviceRegistryRequest,DeviceRegistry>

createDeviceSettings()

public UnaryCallSettings<CreateDeviceRequest,Device> createDeviceSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateDeviceRequest,Device>

deleteDeviceRegistrySettings()

public UnaryCallSettings<DeleteDeviceRegistryRequest,Empty> deleteDeviceRegistrySettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteDeviceRegistryRequest,Empty>

deleteDeviceSettings()

public UnaryCallSettings<DeleteDeviceRequest,Empty> deleteDeviceSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteDeviceRequest,Empty>

getDeviceRegistrySettings()

public UnaryCallSettings<GetDeviceRegistryRequest,DeviceRegistry> getDeviceRegistrySettings()

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

Returns

Type	Description
UnaryCallSettings<GetDeviceRegistryRequest,DeviceRegistry>

getDeviceSettings()

public UnaryCallSettings<GetDeviceRequest,Device> getDeviceSettings()

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

Returns

Type	Description
UnaryCallSettings<GetDeviceRequest,Device>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns

Type	Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

listDeviceConfigVersionsSettings()

public UnaryCallSettings<ListDeviceConfigVersionsRequest,ListDeviceConfigVersionsResponse> listDeviceConfigVersionsSettings()

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

Returns

Type	Description
UnaryCallSettings<ListDeviceConfigVersionsRequest,ListDeviceConfigVersionsResponse>

listDeviceRegistriesSettings()

public PagedCallSettings<ListDeviceRegistriesRequest,ListDeviceRegistriesResponse,DeviceManagerClient.ListDeviceRegistriesPagedResponse> listDeviceRegistriesSettings()

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

Returns

Type	Description
PagedCallSettings<ListDeviceRegistriesRequest,ListDeviceRegistriesResponse,ListDeviceRegistriesPagedResponse>

listDeviceStatesSettings()

public UnaryCallSettings<ListDeviceStatesRequest,ListDeviceStatesResponse> listDeviceStatesSettings()

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

Returns

Type	Description
UnaryCallSettings<ListDeviceStatesRequest,ListDeviceStatesResponse>

listDevicesSettings()

public PagedCallSettings<ListDevicesRequest,ListDevicesResponse,DeviceManagerClient.ListDevicesPagedResponse> listDevicesSettings()

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

Returns

Type	Description
PagedCallSettings<ListDevicesRequest,ListDevicesResponse,ListDevicesPagedResponse>

modifyCloudToDeviceConfigSettings()

public UnaryCallSettings<ModifyCloudToDeviceConfigRequest,DeviceConfig> modifyCloudToDeviceConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<ModifyCloudToDeviceConfigRequest,DeviceConfig>

sendCommandToDeviceSettings()

public UnaryCallSettings<SendCommandToDeviceRequest,SendCommandToDeviceResponse> sendCommandToDeviceSettings()

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

Returns

Type	Description
UnaryCallSettings<SendCommandToDeviceRequest,SendCommandToDeviceResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns

Type	Description
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

Type	Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public DeviceManagerSettings.Builder toBuilder()

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

Returns

Type	Description
DeviceManagerSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

unbindDeviceFromGatewaySettings()

public UnaryCallSettings<UnbindDeviceFromGatewayRequest,UnbindDeviceFromGatewayResponse> unbindDeviceFromGatewaySettings()

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

Returns

Type	Description
UnaryCallSettings<UnbindDeviceFromGatewayRequest,UnbindDeviceFromGatewayResponse>

updateDeviceRegistrySettings()

public UnaryCallSettings<UpdateDeviceRegistryRequest,DeviceRegistry> updateDeviceRegistrySettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateDeviceRegistryRequest,DeviceRegistry>

updateDeviceSettings()

public UnaryCallSettings<UpdateDeviceRequest,Device> updateDeviceSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateDeviceRequest,Device>