com.google.cloud.iot.v1

Class DeviceManagerSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<DeviceManagerSettings>

com.google.cloud.iot.v1.DeviceManagerSettings

@Generated(value="by gapic-generator")
 @BetaApi
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().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 DeviceManagerSettings deviceManagerSettings = deviceManagerSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceManagerSettings.Builder Builder for DeviceManagerSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeviceManagerSettings(DeviceManagerSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
UnaryCallSettings<com.google.cloud.iot.v1.BindDeviceToGatewayRequest,com.google.cloud.iot.v1.BindDeviceToGatewayResponse>	bindDeviceToGatewaySettings() Returns the object with the settings used for calls to bindDeviceToGateway.
static DeviceManagerSettings	create(DeviceManagerStubSettings stub)
UnaryCallSettings<com.google.cloud.iot.v1.CreateDeviceRegistryRequest,com.google.cloud.iot.v1.DeviceRegistry>	createDeviceRegistrySettings() Returns the object with the settings used for calls to createDeviceRegistry.
UnaryCallSettings<com.google.cloud.iot.v1.CreateDeviceRequest,com.google.cloud.iot.v1.Device>	createDeviceSettings() Returns the object with the settings used for calls to createDevice.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<com.google.cloud.iot.v1.DeleteDeviceRegistryRequest,Empty>	deleteDeviceRegistrySettings() Returns the object with the settings used for calls to deleteDeviceRegistry.
UnaryCallSettings<com.google.cloud.iot.v1.DeleteDeviceRequest,Empty>	deleteDeviceSettings() Returns the object with the settings used for calls to deleteDevice.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.cloud.iot.v1.GetDeviceRegistryRequest,com.google.cloud.iot.v1.DeviceRegistry>	getDeviceRegistrySettings() Returns the object with the settings used for calls to getDeviceRegistry.
UnaryCallSettings<com.google.cloud.iot.v1.GetDeviceRequest,com.google.cloud.iot.v1.Device>	getDeviceSettings() Returns the object with the settings used for calls to getDevice.
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
UnaryCallSettings<com.google.cloud.iot.v1.ListDeviceConfigVersionsRequest,com.google.cloud.iot.v1.ListDeviceConfigVersionsResponse>	listDeviceConfigVersionsSettings() Returns the object with the settings used for calls to listDeviceConfigVersions.
PagedCallSettings<com.google.cloud.iot.v1.ListDeviceRegistriesRequest,com.google.cloud.iot.v1.ListDeviceRegistriesResponse,DeviceManagerClient.ListDeviceRegistriesPagedResponse>	listDeviceRegistriesSettings() Returns the object with the settings used for calls to listDeviceRegistries.
PagedCallSettings<com.google.cloud.iot.v1.ListDevicesRequest,com.google.cloud.iot.v1.ListDevicesResponse,DeviceManagerClient.ListDevicesPagedResponse>	listDevicesSettings() Returns the object with the settings used for calls to listDevices.
UnaryCallSettings<com.google.cloud.iot.v1.ListDeviceStatesRequest,com.google.cloud.iot.v1.ListDeviceStatesResponse>	listDeviceStatesSettings() Returns the object with the settings used for calls to listDeviceStates.
UnaryCallSettings<com.google.cloud.iot.v1.ModifyCloudToDeviceConfigRequest,com.google.cloud.iot.v1.DeviceConfig>	modifyCloudToDeviceConfigSettings() Returns the object with the settings used for calls to modifyCloudToDeviceConfig.
static DeviceManagerSettings.Builder	newBuilder() Returns a new builder for this class.
static DeviceManagerSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<com.google.cloud.iot.v1.SendCommandToDeviceRequest,com.google.cloud.iot.v1.SendCommandToDeviceResponse>	sendCommandToDeviceSettings() Returns the object with the settings used for calls to sendCommandToDevice.
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
DeviceManagerSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<com.google.cloud.iot.v1.UnbindDeviceFromGatewayRequest,com.google.cloud.iot.v1.UnbindDeviceFromGatewayResponse>	unbindDeviceFromGatewaySettings() Returns the object with the settings used for calls to unbindDeviceFromGateway.
UnaryCallSettings<com.google.cloud.iot.v1.UpdateDeviceRegistryRequest,com.google.cloud.iot.v1.DeviceRegistry>	updateDeviceRegistrySettings() Returns the object with the settings used for calls to updateDeviceRegistry.
UnaryCallSettings<com.google.cloud.iot.v1.UpdateDeviceRequest,com.google.cloud.iot.v1.Device>	updateDeviceSettings() Returns the object with the settings used for calls to updateDevice.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeviceManagerSettings

protected DeviceManagerSettings(DeviceManagerSettings.Builder settingsBuilder)
                         throws IOException

Throws:

IOException

Method Detail

createDeviceRegistrySettings

public UnaryCallSettings<com.google.cloud.iot.v1.CreateDeviceRegistryRequest,com.google.cloud.iot.v1.DeviceRegistry> createDeviceRegistrySettings()

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

getDeviceRegistrySettings

public UnaryCallSettings<com.google.cloud.iot.v1.GetDeviceRegistryRequest,com.google.cloud.iot.v1.DeviceRegistry> getDeviceRegistrySettings()

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

updateDeviceRegistrySettings

public UnaryCallSettings<com.google.cloud.iot.v1.UpdateDeviceRegistryRequest,com.google.cloud.iot.v1.DeviceRegistry> updateDeviceRegistrySettings()

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

deleteDeviceRegistrySettings

public UnaryCallSettings<com.google.cloud.iot.v1.DeleteDeviceRegistryRequest,Empty> deleteDeviceRegistrySettings()

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

listDeviceRegistriesSettings

public PagedCallSettings<com.google.cloud.iot.v1.ListDeviceRegistriesRequest,com.google.cloud.iot.v1.ListDeviceRegistriesResponse,DeviceManagerClient.ListDeviceRegistriesPagedResponse> listDeviceRegistriesSettings()

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

createDeviceSettings

public UnaryCallSettings<com.google.cloud.iot.v1.CreateDeviceRequest,com.google.cloud.iot.v1.Device> createDeviceSettings()

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

getDeviceSettings

public UnaryCallSettings<com.google.cloud.iot.v1.GetDeviceRequest,com.google.cloud.iot.v1.Device> getDeviceSettings()

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

updateDeviceSettings

public UnaryCallSettings<com.google.cloud.iot.v1.UpdateDeviceRequest,com.google.cloud.iot.v1.Device> updateDeviceSettings()

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

deleteDeviceSettings

public UnaryCallSettings<com.google.cloud.iot.v1.DeleteDeviceRequest,Empty> deleteDeviceSettings()

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

listDevicesSettings

public PagedCallSettings<com.google.cloud.iot.v1.ListDevicesRequest,com.google.cloud.iot.v1.ListDevicesResponse,DeviceManagerClient.ListDevicesPagedResponse> listDevicesSettings()

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

modifyCloudToDeviceConfigSettings

public UnaryCallSettings<com.google.cloud.iot.v1.ModifyCloudToDeviceConfigRequest,com.google.cloud.iot.v1.DeviceConfig> modifyCloudToDeviceConfigSettings()

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

listDeviceConfigVersionsSettings

public UnaryCallSettings<com.google.cloud.iot.v1.ListDeviceConfigVersionsRequest,com.google.cloud.iot.v1.ListDeviceConfigVersionsResponse> listDeviceConfigVersionsSettings()

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

listDeviceStatesSettings

public UnaryCallSettings<com.google.cloud.iot.v1.ListDeviceStatesRequest,com.google.cloud.iot.v1.ListDeviceStatesResponse> listDeviceStatesSettings()

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

setIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

getIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

testIamPermissionsSettings

public UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

sendCommandToDeviceSettings

public UnaryCallSettings<com.google.cloud.iot.v1.SendCommandToDeviceRequest,com.google.cloud.iot.v1.SendCommandToDeviceResponse> sendCommandToDeviceSettings()

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

bindDeviceToGatewaySettings

public UnaryCallSettings<com.google.cloud.iot.v1.BindDeviceToGatewayRequest,com.google.cloud.iot.v1.BindDeviceToGatewayResponse> bindDeviceToGatewaySettings()

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

unbindDeviceFromGatewaySettings

public UnaryCallSettings<com.google.cloud.iot.v1.UnbindDeviceFromGatewayRequest,com.google.cloud.iot.v1.UnbindDeviceFromGatewayResponse> unbindDeviceFromGatewaySettings()

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

create

public static final DeviceManagerSettings create(DeviceManagerStubSettings stub)
                                          throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static DeviceManagerSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static DeviceManagerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public DeviceManagerSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<DeviceManagerSettings>