Class ProjectsSettings (1.15.0)

Version 1.15.0

• 1.64.0 (latest)
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.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.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class ProjectsSettings extends ClientSettings<ProjectsSettings>

Settings class to configure an instance of ProjectsClient.

The default instance has everything set to sensible defaults:

• The default service address (compute.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 get 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
 ProjectsSettings.Builder projectsSettingsBuilder = ProjectsSettings.newBuilder();
 projectsSettingsBuilder
     .getSettings()
     .setRetrySettings(
         projectsSettingsBuilder.getSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ProjectsSettings projectsSettings = projectsSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > ProjectsSettings

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

public static final ProjectsSettings create(ProjectsStubSettings stub)

Parameter

Name	Description
stub	ProjectsStubSettings

Returns

Type	Description
ProjectsSettings

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

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns a new builder for this class.

Returns

Type	Description
ProjectsSettings.Builder

newBuilder(ClientContext clientContext)

public static ProjectsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	ClientContext

Returns

Type	Description
ProjectsSettings.Builder

Constructors

ProjectsSettings(ProjectsSettings.Builder settingsBuilder)

protected ProjectsSettings(ProjectsSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	ProjectsSettings.Builder

Methods

disableXpnHostOperationSettings()

public OperationCallSettings<DisableXpnHostProjectRequest,Operation,Operation> disableXpnHostOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DisableXpnHostProjectRequest,Operation,Operation>

disableXpnHostSettings()

public UnaryCallSettings<DisableXpnHostProjectRequest,Operation> disableXpnHostSettings()

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

Returns

Type	Description
UnaryCallSettings<DisableXpnHostProjectRequest,Operation>

disableXpnResourceOperationSettings()

public OperationCallSettings<DisableXpnResourceProjectRequest,Operation,Operation> disableXpnResourceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DisableXpnResourceProjectRequest,Operation,Operation>

disableXpnResourceSettings()

public UnaryCallSettings<DisableXpnResourceProjectRequest,Operation> disableXpnResourceSettings()

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

Returns

Type	Description
UnaryCallSettings<DisableXpnResourceProjectRequest,Operation>

enableXpnHostOperationSettings()

public OperationCallSettings<EnableXpnHostProjectRequest,Operation,Operation> enableXpnHostOperationSettings()

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

Returns

Type	Description
OperationCallSettings<EnableXpnHostProjectRequest,Operation,Operation>

enableXpnHostSettings()

public UnaryCallSettings<EnableXpnHostProjectRequest,Operation> enableXpnHostSettings()

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

Returns

Type	Description
UnaryCallSettings<EnableXpnHostProjectRequest,Operation>

enableXpnResourceOperationSettings()

public OperationCallSettings<EnableXpnResourceProjectRequest,Operation,Operation> enableXpnResourceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<EnableXpnResourceProjectRequest,Operation,Operation>

enableXpnResourceSettings()

public UnaryCallSettings<EnableXpnResourceProjectRequest,Operation> enableXpnResourceSettings()

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

Returns

Type	Description
UnaryCallSettings<EnableXpnResourceProjectRequest,Operation>

getSettings()

public UnaryCallSettings<GetProjectRequest,Project> getSettings()

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

Returns

Type	Description
UnaryCallSettings<GetProjectRequest,Project>

getXpnHostSettings()

public UnaryCallSettings<GetXpnHostProjectRequest,Project> getXpnHostSettings()

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

Returns

Type	Description
UnaryCallSettings<GetXpnHostProjectRequest,Project>

getXpnResourcesSettings()

public PagedCallSettings<GetXpnResourcesProjectsRequest,ProjectsGetXpnResources,ProjectsClient.GetXpnResourcesPagedResponse> getXpnResourcesSettings()

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

Returns

Type	Description
PagedCallSettings<GetXpnResourcesProjectsRequest,ProjectsGetXpnResources,GetXpnResourcesPagedResponse>

listXpnHostsSettings()

public PagedCallSettings<ListXpnHostsProjectsRequest,XpnHostList,ProjectsClient.ListXpnHostsPagedResponse> listXpnHostsSettings()

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

Returns

Type	Description
PagedCallSettings<ListXpnHostsProjectsRequest,XpnHostList,ListXpnHostsPagedResponse>

moveDiskOperationSettings()

public OperationCallSettings<MoveDiskProjectRequest,Operation,Operation> moveDiskOperationSettings()

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

Returns

Type	Description
OperationCallSettings<MoveDiskProjectRequest,Operation,Operation>

moveDiskSettings()

public UnaryCallSettings<MoveDiskProjectRequest,Operation> moveDiskSettings()

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

Returns

Type	Description
UnaryCallSettings<MoveDiskProjectRequest,Operation>

moveInstanceOperationSettings()

public OperationCallSettings<MoveInstanceProjectRequest,Operation,Operation> moveInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<MoveInstanceProjectRequest,Operation,Operation>

moveInstanceSettings()

public UnaryCallSettings<MoveInstanceProjectRequest,Operation> moveInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<MoveInstanceProjectRequest,Operation>

setCommonInstanceMetadataOperationSettings()

public OperationCallSettings<SetCommonInstanceMetadataProjectRequest,Operation,Operation> setCommonInstanceMetadataOperationSettings()

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

Returns

Type	Description
OperationCallSettings<SetCommonInstanceMetadataProjectRequest,Operation,Operation>

setCommonInstanceMetadataSettings()

public UnaryCallSettings<SetCommonInstanceMetadataProjectRequest,Operation> setCommonInstanceMetadataSettings()

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

Returns

Type	Description
UnaryCallSettings<SetCommonInstanceMetadataProjectRequest,Operation>

setDefaultNetworkTierOperationSettings()

public OperationCallSettings<SetDefaultNetworkTierProjectRequest,Operation,Operation> setDefaultNetworkTierOperationSettings()

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

Returns

Type	Description
OperationCallSettings<SetDefaultNetworkTierProjectRequest,Operation,Operation>

setDefaultNetworkTierSettings()

public UnaryCallSettings<SetDefaultNetworkTierProjectRequest,Operation> setDefaultNetworkTierSettings()

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

Returns

Type	Description
UnaryCallSettings<SetDefaultNetworkTierProjectRequest,Operation>

setUsageExportBucketOperationSettings()

public OperationCallSettings<SetUsageExportBucketProjectRequest,Operation,Operation> setUsageExportBucketOperationSettings()

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

Returns

Type	Description
OperationCallSettings<SetUsageExportBucketProjectRequest,Operation,Operation>

setUsageExportBucketSettings()

public UnaryCallSettings<SetUsageExportBucketProjectRequest,Operation> setUsageExportBucketSettings()

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

Returns

Type	Description
UnaryCallSettings<SetUsageExportBucketProjectRequest,Operation>

toBuilder()

public ProjectsSettings.Builder toBuilder()

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

Returns

Type	Description
ProjectsSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()