com.google.cloud.resourcemanager.v3

Class OrganizationsSettings

java.lang.Object

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

com.google.cloud.resourcemanager.v3.OrganizationsSettings

@Generated(value="by gapic-generator-java")
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();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static OrganizationsSettings	create(OrganizationsStubSettings stub)
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 gRPC ChannelProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
UnaryCallSettings<GetOrganizationRequest,Organization>	getOrganizationSettings() Returns the object with the settings used for calls to getOrganization.
static OrganizationsSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static OrganizationsSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
static OrganizationsSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
PagedCallSettings<SearchOrganizationsRequest,SearchOrganizationsResponse,OrganizationsClient.SearchOrganizationsPagedResponse>	searchOrganizationsSettings() Returns the object with the settings used for calls to searchOrganizations.
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.
OrganizationsSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OrganizationsSettings

protected OrganizationsSettings(OrganizationsSettings.Builder settingsBuilder)
                         throws IOException

Throws:

IOException

Method Detail

getOrganizationSettings

public UnaryCallSettings<GetOrganizationRequest,Organization> getOrganizationSettings()

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

searchOrganizationsSettings

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

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

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.

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.

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.

create

public static final OrganizationsSettings create(OrganizationsStubSettings 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 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()

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

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static OrganizationsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static OrganizationsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public OrganizationsSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<OrganizationsSettings>