com.google.cloud.compute.v1.stub

Class ProjectsStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<ProjectsStubSettings>

com.google.cloud.compute.v1.stub.ProjectsStubSettings

@Generated(value="by gapic-generator-java")
public class ProjectsStubSettings
extends com.google.api.gax.rpc.StubSettings<ProjectsStubSettings>

Settings class to configure an instance of ProjectsStub.

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
 ProjectsStubSettings.Builder projectsSettingsBuilder = ProjectsStubSettings.newBuilder();
 projectsSettingsBuilder
     .getSettings()
     .setRetrySettings(
         projectsSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ProjectsStubSettings projectsSettings = projectsSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ProjectsStub	createStub()
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DisableXpnHostProjectRequest,Operation,Operation>	disableXpnHostOperationSettings() Returns the object with the settings used for calls to disableXpnHost.
com.google.api.gax.rpc.UnaryCallSettings<DisableXpnHostProjectRequest,Operation>	disableXpnHostSettings() Returns the object with the settings used for calls to disableXpnHost.
com.google.api.gax.rpc.OperationCallSettings<DisableXpnResourceProjectRequest,Operation,Operation>	disableXpnResourceOperationSettings() Returns the object with the settings used for calls to disableXpnResource.
com.google.api.gax.rpc.UnaryCallSettings<DisableXpnResourceProjectRequest,Operation>	disableXpnResourceSettings() Returns the object with the settings used for calls to disableXpnResource.
com.google.api.gax.rpc.OperationCallSettings<EnableXpnHostProjectRequest,Operation,Operation>	enableXpnHostOperationSettings() Returns the object with the settings used for calls to enableXpnHost.
com.google.api.gax.rpc.UnaryCallSettings<EnableXpnHostProjectRequest,Operation>	enableXpnHostSettings() Returns the object with the settings used for calls to enableXpnHost.
com.google.api.gax.rpc.OperationCallSettings<EnableXpnResourceProjectRequest,Operation,Operation>	enableXpnResourceOperationSettings() Returns the object with the settings used for calls to enableXpnResource.
com.google.api.gax.rpc.UnaryCallSettings<EnableXpnResourceProjectRequest,Operation>	enableXpnResourceSettings() Returns the object with the settings used for calls to enableXpnResource.
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.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.UnaryCallSettings<GetProjectRequest,Project>	getSettings() Returns the object with the settings used for calls to get.
com.google.api.gax.rpc.UnaryCallSettings<GetXpnHostProjectRequest,Project>	getXpnHostSettings() Returns the object with the settings used for calls to getXpnHost.
com.google.api.gax.rpc.PagedCallSettings<GetXpnResourcesProjectsRequest,ProjectsGetXpnResources,ProjectsClient.GetXpnResourcesPagedResponse>	getXpnResourcesSettings() Returns the object with the settings used for calls to getXpnResources.
com.google.api.gax.rpc.PagedCallSettings<ListXpnHostsProjectsRequest,XpnHostList,ProjectsClient.ListXpnHostsPagedResponse>	listXpnHostsSettings() Returns the object with the settings used for calls to listXpnHosts.
com.google.api.gax.rpc.OperationCallSettings<MoveDiskProjectRequest,Operation,Operation>	moveDiskOperationSettings() Returns the object with the settings used for calls to moveDisk.
com.google.api.gax.rpc.UnaryCallSettings<MoveDiskProjectRequest,Operation>	moveDiskSettings() Returns the object with the settings used for calls to moveDisk.
com.google.api.gax.rpc.OperationCallSettings<MoveInstanceProjectRequest,Operation,Operation>	moveInstanceOperationSettings() Returns the object with the settings used for calls to moveInstance.
com.google.api.gax.rpc.UnaryCallSettings<MoveInstanceProjectRequest,Operation>	moveInstanceSettings() Returns the object with the settings used for calls to moveInstance.
static ProjectsStubSettings.Builder	newBuilder() Returns a new builder for this class.
static ProjectsStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.OperationCallSettings<SetCloudArmorTierProjectRequest,Operation,Operation>	setCloudArmorTierOperationSettings() Returns the object with the settings used for calls to setCloudArmorTier.
com.google.api.gax.rpc.UnaryCallSettings<SetCloudArmorTierProjectRequest,Operation>	setCloudArmorTierSettings() Returns the object with the settings used for calls to setCloudArmorTier.
com.google.api.gax.rpc.OperationCallSettings<SetCommonInstanceMetadataProjectRequest,Operation,Operation>	setCommonInstanceMetadataOperationSettings() Returns the object with the settings used for calls to setCommonInstanceMetadata.
com.google.api.gax.rpc.UnaryCallSettings<SetCommonInstanceMetadataProjectRequest,Operation>	setCommonInstanceMetadataSettings() Returns the object with the settings used for calls to setCommonInstanceMetadata.
com.google.api.gax.rpc.OperationCallSettings<SetDefaultNetworkTierProjectRequest,Operation,Operation>	setDefaultNetworkTierOperationSettings() Returns the object with the settings used for calls to setDefaultNetworkTier.
com.google.api.gax.rpc.UnaryCallSettings<SetDefaultNetworkTierProjectRequest,Operation>	setDefaultNetworkTierSettings() Returns the object with the settings used for calls to setDefaultNetworkTier.
com.google.api.gax.rpc.OperationCallSettings<SetUsageExportBucketProjectRequest,Operation,Operation>	setUsageExportBucketOperationSettings() Returns the object with the settings used for calls to setUsageExportBucket.
com.google.api.gax.rpc.UnaryCallSettings<SetUsageExportBucketProjectRequest,Operation>	setUsageExportBucketSettings() Returns the object with the settings used for calls to setUsageExportBucket.
ProjectsStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectsStubSettings

protected ProjectsStubSettings(ProjectsStubSettings.Builder settingsBuilder)
                        throws IOException

Throws:

IOException

Method Detail

disableXpnHostSettings

public com.google.api.gax.rpc.UnaryCallSettings<DisableXpnHostProjectRequest,Operation> disableXpnHostSettings()

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

disableXpnHostOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DisableXpnHostProjectRequest,Operation,Operation> disableXpnHostOperationSettings()

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

disableXpnResourceSettings

public com.google.api.gax.rpc.UnaryCallSettings<DisableXpnResourceProjectRequest,Operation> disableXpnResourceSettings()

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

disableXpnResourceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DisableXpnResourceProjectRequest,Operation,Operation> disableXpnResourceOperationSettings()

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

enableXpnHostSettings

public com.google.api.gax.rpc.UnaryCallSettings<EnableXpnHostProjectRequest,Operation> enableXpnHostSettings()

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

enableXpnHostOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<EnableXpnHostProjectRequest,Operation,Operation> enableXpnHostOperationSettings()

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

enableXpnResourceSettings

public com.google.api.gax.rpc.UnaryCallSettings<EnableXpnResourceProjectRequest,Operation> enableXpnResourceSettings()

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

enableXpnResourceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<EnableXpnResourceProjectRequest,Operation,Operation> enableXpnResourceOperationSettings()

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

getSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetProjectRequest,Project> getSettings()

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

getXpnHostSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetXpnHostProjectRequest,Project> getXpnHostSettings()

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

getXpnResourcesSettings

public com.google.api.gax.rpc.PagedCallSettings<GetXpnResourcesProjectsRequest,ProjectsGetXpnResources,ProjectsClient.GetXpnResourcesPagedResponse> getXpnResourcesSettings()

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

listXpnHostsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListXpnHostsProjectsRequest,XpnHostList,ProjectsClient.ListXpnHostsPagedResponse> listXpnHostsSettings()

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

moveDiskSettings

public com.google.api.gax.rpc.UnaryCallSettings<MoveDiskProjectRequest,Operation> moveDiskSettings()

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

moveDiskOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<MoveDiskProjectRequest,Operation,Operation> moveDiskOperationSettings()

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

moveInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<MoveInstanceProjectRequest,Operation> moveInstanceSettings()

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

moveInstanceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<MoveInstanceProjectRequest,Operation,Operation> moveInstanceOperationSettings()

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

setCloudArmorTierSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetCloudArmorTierProjectRequest,Operation> setCloudArmorTierSettings()

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

setCloudArmorTierOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SetCloudArmorTierProjectRequest,Operation,Operation> setCloudArmorTierOperationSettings()

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

setCommonInstanceMetadataSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetCommonInstanceMetadataProjectRequest,Operation> setCommonInstanceMetadataSettings()

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

setCommonInstanceMetadataOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SetCommonInstanceMetadataProjectRequest,Operation,Operation> setCommonInstanceMetadataOperationSettings()

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

setDefaultNetworkTierSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetDefaultNetworkTierProjectRequest,Operation> setDefaultNetworkTierSettings()

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

setDefaultNetworkTierOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SetDefaultNetworkTierProjectRequest,Operation,Operation> setDefaultNetworkTierOperationSettings()

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

setUsageExportBucketSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetUsageExportBucketProjectRequest,Operation> setUsageExportBucketSettings()

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

setUsageExportBucketOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SetUsageExportBucketProjectRequest,Operation,Operation> setUsageExportBucketOperationSettings()

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

createStub

public ProjectsStub createStub()
                        throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<ProjectsStubSettings>

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

@ObsoleteApi(value="Use getEndpoint() instead")
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 com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static ProjectsStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static ProjectsStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public ProjectsStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<ProjectsStubSettings>