Class AnalyticsAdminServiceSettings (0.68.0)

public class AnalyticsAdminServiceSettings extends ClientSettings<AnalyticsAdminServiceSettings>

Settings class to configure an instance of AnalyticsAdminServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (analyticsadmin.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 RetrySettings of getAccount:


 // 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
 AnalyticsAdminServiceSettings.Builder analyticsAdminServiceSettingsBuilder =
     AnalyticsAdminServiceSettings.newBuilder();
 analyticsAdminServiceSettingsBuilder
     .getAccountSettings()
     .setRetrySettings(
         analyticsAdminServiceSettingsBuilder
             .getAccountSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 AnalyticsAdminServiceSettings analyticsAdminServiceSettings =
     analyticsAdminServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > ClientSettings > AnalyticsAdminServiceSettings

Static Methods

create(AnalyticsAdminServiceStubSettings stub)

public static final AnalyticsAdminServiceSettings create(AnalyticsAdminServiceStubSettings stub)
Parameter
Name Description
stub AnalyticsAdminServiceStubSettings
Returns
Type Description
AnalyticsAdminServiceSettings
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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns a new gRPC builder for this class.

Returns
Type Description
AnalyticsAdminServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static AnalyticsAdminServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
AnalyticsAdminServiceSettings.Builder

newHttpJsonBuilder()

public static AnalyticsAdminServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
AnalyticsAdminServiceSettings.Builder

Constructors

AnalyticsAdminServiceSettings(AnalyticsAdminServiceSettings.Builder settingsBuilder)

protected AnalyticsAdminServiceSettings(AnalyticsAdminServiceSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder AnalyticsAdminServiceSettings.Builder

Methods

acknowledgeUserDataCollectionSettings()

public UnaryCallSettings<AcknowledgeUserDataCollectionRequest,AcknowledgeUserDataCollectionResponse> acknowledgeUserDataCollectionSettings()

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

archiveCustomDimensionSettings()

public UnaryCallSettings<ArchiveCustomDimensionRequest,Empty> archiveCustomDimensionSettings()

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

archiveCustomMetricSettings()

public UnaryCallSettings<ArchiveCustomMetricRequest,Empty> archiveCustomMetricSettings()

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

createConversionEventSettings() (deprecated)

public UnaryCallSettings<CreateConversionEventRequest,ConversionEvent> createConversionEventSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

createCustomDimensionSettings()

public UnaryCallSettings<CreateCustomDimensionRequest,CustomDimension> createCustomDimensionSettings()

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

createCustomMetricSettings()

public UnaryCallSettings<CreateCustomMetricRequest,CustomMetric> createCustomMetricSettings()

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

createDataStreamSettings()

public UnaryCallSettings<CreateDataStreamRequest,DataStream> createDataStreamSettings()

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

createFirebaseLinkSettings()

public UnaryCallSettings<CreateFirebaseLinkRequest,FirebaseLink> createFirebaseLinkSettings()

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

createGoogleAdsLinkSettings()

public UnaryCallSettings<CreateGoogleAdsLinkRequest,GoogleAdsLink> createGoogleAdsLinkSettings()

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

createKeyEventSettings()

public UnaryCallSettings<CreateKeyEventRequest,KeyEvent> createKeyEventSettings()

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

createMeasurementProtocolSecretSettings()

public UnaryCallSettings<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> createMeasurementProtocolSecretSettings()

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

createPropertySettings()

public UnaryCallSettings<CreatePropertyRequest,Property> createPropertySettings()

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

deleteAccountSettings()

public UnaryCallSettings<DeleteAccountRequest,Empty> deleteAccountSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAccountRequest,Empty>

deleteConversionEventSettings() (deprecated)

public UnaryCallSettings<DeleteConversionEventRequest,Empty> deleteConversionEventSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

deleteDataStreamSettings()

public UnaryCallSettings<DeleteDataStreamRequest,Empty> deleteDataStreamSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDataStreamRequest,Empty>

deleteFirebaseLinkSettings()

public UnaryCallSettings<DeleteFirebaseLinkRequest,Empty> deleteFirebaseLinkSettings()

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

deleteGoogleAdsLinkSettings()

public UnaryCallSettings<DeleteGoogleAdsLinkRequest,Empty> deleteGoogleAdsLinkSettings()

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

deleteKeyEventSettings()

public UnaryCallSettings<DeleteKeyEventRequest,Empty> deleteKeyEventSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteKeyEventRequest,Empty>

deleteMeasurementProtocolSecretSettings()

public UnaryCallSettings<DeleteMeasurementProtocolSecretRequest,Empty> deleteMeasurementProtocolSecretSettings()

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

deletePropertySettings()

public UnaryCallSettings<DeletePropertyRequest,Property> deletePropertySettings()

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

getAccountSettings()

public UnaryCallSettings<GetAccountRequest,Account> getAccountSettings()

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

Returns
Type Description
UnaryCallSettings<GetAccountRequest,Account>

getConversionEventSettings() (deprecated)

public UnaryCallSettings<GetConversionEventRequest,ConversionEvent> getConversionEventSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

getCustomDimensionSettings()

public UnaryCallSettings<GetCustomDimensionRequest,CustomDimension> getCustomDimensionSettings()

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

getCustomMetricSettings()

public UnaryCallSettings<GetCustomMetricRequest,CustomMetric> getCustomMetricSettings()

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

getDataRetentionSettingsSettings()

public UnaryCallSettings<GetDataRetentionSettingsRequest,DataRetentionSettings> getDataRetentionSettingsSettings()

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

getDataSharingSettingsSettings()

public UnaryCallSettings<GetDataSharingSettingsRequest,DataSharingSettings> getDataSharingSettingsSettings()

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

getDataStreamSettings()

public UnaryCallSettings<GetDataStreamRequest,DataStream> getDataStreamSettings()

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

getKeyEventSettings()

public UnaryCallSettings<GetKeyEventRequest,KeyEvent> getKeyEventSettings()

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

Returns
Type Description
UnaryCallSettings<GetKeyEventRequest,KeyEvent>

getMeasurementProtocolSecretSettings()

public UnaryCallSettings<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret> getMeasurementProtocolSecretSettings()

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

getPropertySettings()

public UnaryCallSettings<GetPropertyRequest,Property> getPropertySettings()

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

Returns
Type Description
UnaryCallSettings<GetPropertyRequest,Property>

listAccountSummariesSettings()

public PagedCallSettings<ListAccountSummariesRequest,ListAccountSummariesResponse,AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse> listAccountSummariesSettings()

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

listAccountsSettings()

public PagedCallSettings<ListAccountsRequest,ListAccountsResponse,AnalyticsAdminServiceClient.ListAccountsPagedResponse> listAccountsSettings()

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

listConversionEventsSettings() (deprecated)

public PagedCallSettings<ListConversionEventsRequest,ListConversionEventsResponse,AnalyticsAdminServiceClient.ListConversionEventsPagedResponse> listConversionEventsSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

listCustomDimensionsSettings()

public PagedCallSettings<ListCustomDimensionsRequest,ListCustomDimensionsResponse,AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse> listCustomDimensionsSettings()

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

listCustomMetricsSettings()

public PagedCallSettings<ListCustomMetricsRequest,ListCustomMetricsResponse,AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse> listCustomMetricsSettings()

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

listDataStreamsSettings()

public PagedCallSettings<ListDataStreamsRequest,ListDataStreamsResponse,AnalyticsAdminServiceClient.ListDataStreamsPagedResponse> listDataStreamsSettings()

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

listFirebaseLinksSettings()

public PagedCallSettings<ListFirebaseLinksRequest,ListFirebaseLinksResponse,AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse> listFirebaseLinksSettings()

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

listGoogleAdsLinksSettings()

public PagedCallSettings<ListGoogleAdsLinksRequest,ListGoogleAdsLinksResponse,AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse> listGoogleAdsLinksSettings()

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

listKeyEventsSettings()

public PagedCallSettings<ListKeyEventsRequest,ListKeyEventsResponse,AnalyticsAdminServiceClient.ListKeyEventsPagedResponse> listKeyEventsSettings()

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

listMeasurementProtocolSecretsSettings()

public PagedCallSettings<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsResponse,AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse> listMeasurementProtocolSecretsSettings()

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

listPropertiesSettings()

public PagedCallSettings<ListPropertiesRequest,ListPropertiesResponse,AnalyticsAdminServiceClient.ListPropertiesPagedResponse> listPropertiesSettings()

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

provisionAccountTicketSettings()

public UnaryCallSettings<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse> provisionAccountTicketSettings()

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

runAccessReportSettings()

public UnaryCallSettings<RunAccessReportRequest,RunAccessReportResponse> runAccessReportSettings()

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

searchChangeHistoryEventsSettings()

public PagedCallSettings<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsResponse,AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse> searchChangeHistoryEventsSettings()

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

toBuilder()

public AnalyticsAdminServiceSettings.Builder toBuilder()

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

Returns
Type Description
AnalyticsAdminServiceSettings.Builder
Overrides

updateAccountSettings()

public UnaryCallSettings<UpdateAccountRequest,Account> updateAccountSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateAccountRequest,Account>

updateConversionEventSettings() (deprecated)

public UnaryCallSettings<UpdateConversionEventRequest,ConversionEvent> updateConversionEventSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

updateCustomDimensionSettings()

public UnaryCallSettings<UpdateCustomDimensionRequest,CustomDimension> updateCustomDimensionSettings()

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

updateCustomMetricSettings()

public UnaryCallSettings<UpdateCustomMetricRequest,CustomMetric> updateCustomMetricSettings()

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

updateDataRetentionSettingsSettings()

public UnaryCallSettings<UpdateDataRetentionSettingsRequest,DataRetentionSettings> updateDataRetentionSettingsSettings()

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

updateDataStreamSettings()

public UnaryCallSettings<UpdateDataStreamRequest,DataStream> updateDataStreamSettings()

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

updateGoogleAdsLinkSettings()

public UnaryCallSettings<UpdateGoogleAdsLinkRequest,GoogleAdsLink> updateGoogleAdsLinkSettings()

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

updateKeyEventSettings()

public UnaryCallSettings<UpdateKeyEventRequest,KeyEvent> updateKeyEventSettings()

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

updateMeasurementProtocolSecretSettings()

public UnaryCallSettings<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> updateMeasurementProtocolSecretSettings()

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

updatePropertySettings()

public UnaryCallSettings<UpdatePropertyRequest,Property> updatePropertySettings()

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