Class GroupServiceSettings (3.13.0) 

public class GroupServiceSettings extends ClientSettings<GroupServiceSettings>

Settings class to configure an instance of GroupServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (monitoring.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 getGroup 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
 GroupServiceSettings.Builder groupServiceSettingsBuilder = GroupServiceSettings.newBuilder();
 groupServiceSettingsBuilder
     .getGroupSettings()
     .setRetrySettings(
         groupServiceSettingsBuilder
             .getGroupSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 GroupServiceSettings groupServiceSettings = groupServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > GroupServiceSettings

Static Methods

create(GroupServiceStubSettings stub)

public static final GroupServiceSettings create(GroupServiceStubSettings stub)
Parameter
NameDescription
stubGroupServiceStubSettings
Returns
TypeDescription
GroupServiceSettings
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
TypeDescription
TransportChannelProvider

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

Returns a new builder for this class.

Returns
TypeDescription
GroupServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static GroupServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
GroupServiceSettings.Builder

Constructors

GroupServiceSettings(GroupServiceSettings.Builder settingsBuilder)

protected GroupServiceSettings(GroupServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderGroupServiceSettings.Builder

Methods

createGroupSettings()

public UnaryCallSettings<CreateGroupRequest,Group> createGroupSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateGroupRequest,Group>

deleteGroupSettings()

public UnaryCallSettings<DeleteGroupRequest,Empty> deleteGroupSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteGroupRequest,Empty>

getGroupSettings()

public UnaryCallSettings<GetGroupRequest,Group> getGroupSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetGroupRequest,Group>

listGroupMembersSettings()

public PagedCallSettings<ListGroupMembersRequest,ListGroupMembersResponse,GroupServiceClient.ListGroupMembersPagedResponse> listGroupMembersSettings()

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

Returns
TypeDescription
PagedCallSettings<ListGroupMembersRequest,ListGroupMembersResponse,ListGroupMembersPagedResponse>

listGroupsSettings()

public PagedCallSettings<ListGroupsRequest,ListGroupsResponse,GroupServiceClient.ListGroupsPagedResponse> listGroupsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListGroupsRequest,ListGroupsResponse,ListGroupsPagedResponse>

toBuilder()

public GroupServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
GroupServiceSettings.Builder
Overrides

updateGroupSettings()

public UnaryCallSettings<UpdateGroupRequest,Group> updateGroupSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateGroupRequest,Group>