Class ProjectsSettings (1.3.2)

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 (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 getProject to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProjectsSettings.Builder projectsSettingsBuilder = ProjectsSettings.newBuilder();
 projectsSettingsBuilder
     .getProjectSettings()
     .setRetrySettings(
         projectsSettingsBuilder
             .getProjectSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ProjectsSettings projectsSettings = projectsSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > ProjectsSettings

Static Methods

create(ProjectsStubSettings stub)

public static final ProjectsSettings create(ProjectsStubSettings stub)
Parameter
NameDescription
stubProjectsStubSettings
Returns
TypeDescription
ProjectsSettings
Exceptions
TypeDescription
IOException

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static ProjectsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

newBuilder(ClientContext clientContext)

public static ProjectsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns

Constructors

ProjectsSettings(ProjectsSettings.Builder settingsBuilder)

protected ProjectsSettings(ProjectsSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderProjectsSettings.Builder

Methods

createProjectOperationSettings()

public OperationCallSettings<CreateProjectRequest,Project,CreateProjectMetadata> createProjectOperationSettings()

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

Returns

createProjectSettings()

public UnaryCallSettings<CreateProjectRequest,Operation> createProjectSettings()

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

Returns

deleteProjectOperationSettings()

public OperationCallSettings<DeleteProjectRequest,Project,DeleteProjectMetadata> deleteProjectOperationSettings()

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

Returns

deleteProjectSettings()

public UnaryCallSettings<DeleteProjectRequest,Operation> deleteProjectSettings()

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

Returns

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>

getProjectSettings()

public UnaryCallSettings<GetProjectRequest,Project> getProjectSettings()

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

Returns

listProjectsSettings()

public PagedCallSettings<ListProjectsRequest,ListProjectsResponse,ProjectsClient.ListProjectsPagedResponse> listProjectsSettings()

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

Returns

moveProjectOperationSettings()

public OperationCallSettings<MoveProjectRequest,Project,MoveProjectMetadata> moveProjectOperationSettings()

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

Returns

moveProjectSettings()

public UnaryCallSettings<MoveProjectRequest,Operation> moveProjectSettings()

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

Returns

searchProjectsSettings()

public PagedCallSettings<SearchProjectsRequest,SearchProjectsResponse,ProjectsClient.SearchProjectsPagedResponse> searchProjectsSettings()

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

Returns

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

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

Returns Overrides

undeleteProjectOperationSettings()

public OperationCallSettings<UndeleteProjectRequest,Project,UndeleteProjectMetadata> undeleteProjectOperationSettings()

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

Returns

undeleteProjectSettings()

public UnaryCallSettings<UndeleteProjectRequest,Operation> undeleteProjectSettings()

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

Returns

updateProjectOperationSettings()

public OperationCallSettings<UpdateProjectRequest,Project,UpdateProjectMetadata> updateProjectOperationSettings()

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

Returns

updateProjectSettings()

public UnaryCallSettings<UpdateProjectRequest,Operation> updateProjectSettings()

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

Returns