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(value="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 total timeout of createDeviceRegistry 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
 DeviceManagerStubSettings.Builder deviceManagerSettingsBuilder =
     DeviceManagerStubSettings.newBuilder();
 deviceManagerSettingsBuilder
     .createDeviceRegistrySettings()
     .setRetrySettings(
         deviceManagerSettingsBuilder
             .createDeviceRegistrySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DeviceManagerStubSettings deviceManagerSettings = deviceManagerSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
UnaryCallSettings<BindDeviceToGatewayRequest,BindDeviceToGatewayResponse>	bindDeviceToGatewaySettings() Returns the object with the settings used for calls to bindDeviceToGateway.
UnaryCallSettings<CreateDeviceRegistryRequest,DeviceRegistry>	createDeviceRegistrySettings() Returns the object with the settings used for calls to createDeviceRegistry.
UnaryCallSettings<CreateDeviceRequest,Device>	createDeviceSettings() Returns the object with the settings used for calls to createDevice.
DeviceManagerStub	createStub()
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 ApiClientHeaderProvider.Builder	defaultGrpcApiClientHeaderProviderBuilder()
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static ApiClientHeaderProvider.Builder	defaultHttpJsonApiClientHeaderProviderBuilder()
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteDeviceRegistryRequest,Empty>	deleteDeviceRegistrySettings() Returns the object with the settings used for calls to deleteDeviceRegistry.
UnaryCallSettings<DeleteDeviceRequest,Empty>	deleteDeviceSettings() Returns the object with the settings used for calls to deleteDevice.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<GetDeviceRegistryRequest,DeviceRegistry>	getDeviceRegistrySettings() Returns the object with the settings used for calls to getDeviceRegistry.
UnaryCallSettings<GetDeviceRequest,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<ListDeviceConfigVersionsRequest,ListDeviceConfigVersionsResponse>	listDeviceConfigVersionsSettings() Returns the object with the settings used for calls to listDeviceConfigVersions.
PagedCallSettings<ListDeviceRegistriesRequest,ListDeviceRegistriesResponse,DeviceManagerClient.ListDeviceRegistriesPagedResponse>	listDeviceRegistriesSettings() Returns the object with the settings used for calls to listDeviceRegistries.
PagedCallSettings<ListDevicesRequest,ListDevicesResponse,DeviceManagerClient.ListDevicesPagedResponse>	listDevicesSettings() Returns the object with the settings used for calls to listDevices.
UnaryCallSettings<ListDeviceStatesRequest,ListDeviceStatesResponse>	listDeviceStatesSettings() Returns the object with the settings used for calls to listDeviceStates.
UnaryCallSettings<ModifyCloudToDeviceConfigRequest,DeviceConfig>	modifyCloudToDeviceConfigSettings() Returns the object with the settings used for calls to modifyCloudToDeviceConfig.
static DeviceManagerStubSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static DeviceManagerStubSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
static DeviceManagerStubSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
UnaryCallSettings<SendCommandToDeviceRequest,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.
DeviceManagerStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UnbindDeviceFromGatewayRequest,UnbindDeviceFromGatewayResponse>	unbindDeviceFromGatewaySettings() Returns the object with the settings used for calls to unbindDeviceFromGateway.
UnaryCallSettings<UpdateDeviceRegistryRequest,DeviceRegistry>	updateDeviceRegistrySettings() Returns the object with the settings used for calls to updateDeviceRegistry.
UnaryCallSettings<UpdateDeviceRequest,Device>	updateDeviceSettings() Returns the object with the settings used for calls to updateDevice.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceManagerStubSettings

protected DeviceManagerStubSettings(DeviceManagerStubSettings.Builder settingsBuilder)
                             throws IOException

Throws:

IOException

Method Detail

createDeviceRegistrySettings

public UnaryCallSettings<CreateDeviceRegistryRequest,DeviceRegistry> createDeviceRegistrySettings()

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

getDeviceRegistrySettings

public UnaryCallSettings<GetDeviceRegistryRequest,DeviceRegistry> getDeviceRegistrySettings()

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

updateDeviceRegistrySettings

public UnaryCallSettings<UpdateDeviceRegistryRequest,DeviceRegistry> updateDeviceRegistrySettings()

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

deleteDeviceRegistrySettings

public UnaryCallSettings<DeleteDeviceRegistryRequest,Empty> deleteDeviceRegistrySettings()

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

listDeviceRegistriesSettings

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

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

createDeviceSettings

public UnaryCallSettings<CreateDeviceRequest,Device> createDeviceSettings()

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

getDeviceSettings

public UnaryCallSettings<GetDeviceRequest,Device> getDeviceSettings()

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

updateDeviceSettings

public UnaryCallSettings<UpdateDeviceRequest,Device> updateDeviceSettings()

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

deleteDeviceSettings

public UnaryCallSettings<DeleteDeviceRequest,Empty> deleteDeviceSettings()

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

listDevicesSettings

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

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

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

public DeviceManagerStub createStub()
                             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.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultGrpcApiClientHeaderProviderBuilder

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

defaultHttpJsonApiClientHeaderProviderBuilder

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

defaultApiClientHeaderProviderBuilder

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static DeviceManagerStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static DeviceManagerStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static DeviceManagerStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public DeviceManagerStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class StubSettings<DeviceManagerStubSettings>