Class DeviceManagerStubSettings (2.14.0)

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();
 

Inheritance

java.lang.Object > StubSettings > DeviceManagerStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static DeviceManagerStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
DeviceManagerStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DeviceManagerStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DeviceManagerStubSettings.Builder

newHttpJsonBuilder()

public static DeviceManagerStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
DeviceManagerStubSettings.Builder

Constructors

DeviceManagerStubSettings(DeviceManagerStubSettings.Builder settingsBuilder)

protected DeviceManagerStubSettings(DeviceManagerStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDeviceManagerStubSettings.Builder

Methods

bindDeviceToGatewaySettings()

public UnaryCallSettings<BindDeviceToGatewayRequest,BindDeviceToGatewayResponse> bindDeviceToGatewaySettings()

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

Returns
TypeDescription
UnaryCallSettings<BindDeviceToGatewayRequest,BindDeviceToGatewayResponse>

createDeviceRegistrySettings()

public UnaryCallSettings<CreateDeviceRegistryRequest,DeviceRegistry> createDeviceRegistrySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateDeviceRegistryRequest,DeviceRegistry>

createDeviceSettings()

public UnaryCallSettings<CreateDeviceRequest,Device> createDeviceSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateDeviceRequest,Device>

createStub()

public DeviceManagerStub createStub()
Returns
TypeDescription
DeviceManagerStub
Exceptions
TypeDescription
IOException

deleteDeviceRegistrySettings()

public UnaryCallSettings<DeleteDeviceRegistryRequest,Empty> deleteDeviceRegistrySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteDeviceRegistryRequest,Empty>

deleteDeviceSettings()

public UnaryCallSettings<DeleteDeviceRequest,Empty> deleteDeviceSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteDeviceRequest,Empty>

getDeviceRegistrySettings()

public UnaryCallSettings<GetDeviceRegistryRequest,DeviceRegistry> getDeviceRegistrySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDeviceRegistryRequest,DeviceRegistry>

getDeviceSettings()

public UnaryCallSettings<GetDeviceRequest,Device> getDeviceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDeviceRequest,Device>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<ListDeviceConfigVersionsRequest,ListDeviceConfigVersionsResponse>

listDeviceRegistriesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListDeviceRegistriesRequest,ListDeviceRegistriesResponse,ListDeviceRegistriesPagedResponse>

listDeviceStatesSettings()

public UnaryCallSettings<ListDeviceStatesRequest,ListDeviceStatesResponse> listDeviceStatesSettings()

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

Returns
TypeDescription
UnaryCallSettings<ListDeviceStatesRequest,ListDeviceStatesResponse>

listDevicesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListDevicesRequest,ListDevicesResponse,ListDevicesPagedResponse>

modifyCloudToDeviceConfigSettings()

public UnaryCallSettings<ModifyCloudToDeviceConfigRequest,DeviceConfig> modifyCloudToDeviceConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<ModifyCloudToDeviceConfigRequest,DeviceConfig>

sendCommandToDeviceSettings()

public UnaryCallSettings<SendCommandToDeviceRequest,SendCommandToDeviceResponse> sendCommandToDeviceSettings()

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

Returns
TypeDescription
UnaryCallSettings<SendCommandToDeviceRequest,SendCommandToDeviceResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public DeviceManagerStubSettings.Builder toBuilder()

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

Returns
TypeDescription
DeviceManagerStubSettings.Builder
Overrides

unbindDeviceFromGatewaySettings()

public UnaryCallSettings<UnbindDeviceFromGatewayRequest,UnbindDeviceFromGatewayResponse> unbindDeviceFromGatewaySettings()

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

Returns
TypeDescription
UnaryCallSettings<UnbindDeviceFromGatewayRequest,UnbindDeviceFromGatewayResponse>

updateDeviceRegistrySettings()

public UnaryCallSettings<UpdateDeviceRegistryRequest,DeviceRegistry> updateDeviceRegistrySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateDeviceRegistryRequest,DeviceRegistry>

updateDeviceSettings()

public UnaryCallSettings<UpdateDeviceRequest,Device> updateDeviceSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateDeviceRequest,Device>