Class OrganizationsSettings (1.15.0)

Version 1.15.0

• 1.57.0 (latest)
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.6
• 1.4.0
• 1.3.2
• 1.2.12

public class OrganizationsSettings extends ClientSettings<OrganizationsSettings>

Settings class to configure an instance of OrganizationsClient.

The default instance has everything set to sensible defaults:

• The default service address (cloudresourcemanager.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 getOrganization 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
 OrganizationsSettings.Builder organizationsSettingsBuilder = OrganizationsSettings.newBuilder();
 organizationsSettingsBuilder
     .getOrganizationSettings()
     .setRetrySettings(
         organizationsSettingsBuilder
             .getOrganizationSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OrganizationsSettings organizationsSettings = organizationsSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > OrganizationsSettings

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(OrganizationsStubSettings stub)

public static final OrganizationsSettings create(OrganizationsStubSettings stub)

Parameter
Name	Description
stub	OrganizationsStubSettings

Returns
Type	Description
OrganizationsSettings

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 gRPC ChannelProvider for this service.

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 OrganizationsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
OrganizationsSettings.Builder

newBuilder(ClientContext clientContext)

public static OrganizationsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
OrganizationsSettings.Builder

newHttpJsonBuilder()

public static OrganizationsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
OrganizationsSettings.Builder

Constructors

OrganizationsSettings(OrganizationsSettings.Builder settingsBuilder)

protected OrganizationsSettings(OrganizationsSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	OrganizationsSettings.Builder

Methods

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>

getOrganizationSettings()

public UnaryCallSettings<GetOrganizationRequest,Organization> getOrganizationSettings()

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

Returns
Type	Description
UnaryCallSettings<GetOrganizationRequest,Organization>

searchOrganizationsSettings()

public PagedCallSettings<SearchOrganizationsRequest,SearchOrganizationsResponse,OrganizationsClient.SearchOrganizationsPagedResponse> searchOrganizationsSettings()

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

Returns
Type	Description
PagedCallSettings<SearchOrganizationsRequest,SearchOrganizationsResponse,SearchOrganizationsPagedResponse>

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 OrganizationsSettings.Builder toBuilder()

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

Returns
Type	Description
OrganizationsSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()