Class AnalyticsAdminServiceSettings (0.28.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 total timeout of getAccount 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
 AnalyticsAdminServiceSettings.Builder analyticsAdminServiceSettingsBuilder =
     AnalyticsAdminServiceSettings.newBuilder();
 analyticsAdminServiceSettingsBuilder
     .getAccountSettings()
     .setRetrySettings(
         analyticsAdminServiceSettingsBuilder
             .getAccountSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AnalyticsAdminServiceSettings analyticsAdminServiceSettings =
     analyticsAdminServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > AnalyticsAdminServiceSettings

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(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.

Returns
Type	Description
`UnaryCallSettings<AcknowledgeUserDataCollectionRequest,AcknowledgeUserDataCollectionResponse>`

archiveCustomDimensionSettings()

public UnaryCallSettings<ArchiveCustomDimensionRequest,Empty> archiveCustomDimensionSettings()

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

Returns
Type	Description
`UnaryCallSettings<ArchiveCustomDimensionRequest,Empty>`

archiveCustomMetricSettings()

public UnaryCallSettings<ArchiveCustomMetricRequest,Empty> archiveCustomMetricSettings()

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

Returns
Type	Description
`UnaryCallSettings<ArchiveCustomMetricRequest,Empty>`

createConversionEventSettings()

public UnaryCallSettings<CreateConversionEventRequest,ConversionEvent> createConversionEventSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateConversionEventRequest,ConversionEvent>`

createCustomDimensionSettings()

public UnaryCallSettings<CreateCustomDimensionRequest,CustomDimension> createCustomDimensionSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateCustomDimensionRequest,CustomDimension>`

createCustomMetricSettings()

public UnaryCallSettings<CreateCustomMetricRequest,CustomMetric> createCustomMetricSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateCustomMetricRequest,CustomMetric>`

createDataStreamSettings()

public UnaryCallSettings<CreateDataStreamRequest,DataStream> createDataStreamSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateDataStreamRequest,DataStream>`

createFirebaseLinkSettings()

public UnaryCallSettings<CreateFirebaseLinkRequest,FirebaseLink> createFirebaseLinkSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateFirebaseLinkRequest,FirebaseLink>`

createGoogleAdsLinkSettings()

public UnaryCallSettings<CreateGoogleAdsLinkRequest,GoogleAdsLink> createGoogleAdsLinkSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateGoogleAdsLinkRequest,GoogleAdsLink>`

createMeasurementProtocolSecretSettings()

public UnaryCallSettings<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> createMeasurementProtocolSecretSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret>`

createPropertySettings()

public UnaryCallSettings<CreatePropertyRequest,Property> createPropertySettings()

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

Returns
Type	Description
`UnaryCallSettings<CreatePropertyRequest,Property>`

deleteAccountSettings()

public UnaryCallSettings<DeleteAccountRequest,Empty> deleteAccountSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteAccountRequest,Empty>`

deleteConversionEventSettings()

public UnaryCallSettings<DeleteConversionEventRequest,Empty> deleteConversionEventSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteConversionEventRequest,Empty>`

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.

Returns
Type	Description
`UnaryCallSettings<DeleteFirebaseLinkRequest,Empty>`

deleteGoogleAdsLinkSettings()

public UnaryCallSettings<DeleteGoogleAdsLinkRequest,Empty> deleteGoogleAdsLinkSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteGoogleAdsLinkRequest,Empty>`

deleteMeasurementProtocolSecretSettings()

public UnaryCallSettings<DeleteMeasurementProtocolSecretRequest,Empty> deleteMeasurementProtocolSecretSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteMeasurementProtocolSecretRequest,Empty>`

deletePropertySettings()

public UnaryCallSettings<DeletePropertyRequest,Property> deletePropertySettings()

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

Returns
Type	Description
`UnaryCallSettings<DeletePropertyRequest,Property>`

getAccountSettings()

public UnaryCallSettings<GetAccountRequest,Account> getAccountSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetAccountRequest,Account>`

getConversionEventSettings()

public UnaryCallSettings<GetConversionEventRequest,ConversionEvent> getConversionEventSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetConversionEventRequest,ConversionEvent>`

getCustomDimensionSettings()

public UnaryCallSettings<GetCustomDimensionRequest,CustomDimension> getCustomDimensionSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetCustomDimensionRequest,CustomDimension>`

getCustomMetricSettings()

public UnaryCallSettings<GetCustomMetricRequest,CustomMetric> getCustomMetricSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetCustomMetricRequest,CustomMetric>`

getDataRetentionSettingsSettings()

public UnaryCallSettings<GetDataRetentionSettingsRequest,DataRetentionSettings> getDataRetentionSettingsSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetDataRetentionSettingsRequest,DataRetentionSettings>`

getDataSharingSettingsSettings()

public UnaryCallSettings<GetDataSharingSettingsRequest,DataSharingSettings> getDataSharingSettingsSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetDataSharingSettingsRequest,DataSharingSettings>`

getDataStreamSettings()

public UnaryCallSettings<GetDataStreamRequest,DataStream> getDataStreamSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetDataStreamRequest,DataStream>`

getMeasurementProtocolSecretSettings()

public UnaryCallSettings<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret> getMeasurementProtocolSecretSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret>`

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.

Returns
Type	Description
`PagedCallSettings<ListAccountSummariesRequest,ListAccountSummariesResponse,ListAccountSummariesPagedResponse>`

listAccountsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListAccountsRequest,ListAccountsResponse,ListAccountsPagedResponse>`

listConversionEventsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListConversionEventsRequest,ListConversionEventsResponse,ListConversionEventsPagedResponse>`

listCustomDimensionsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListCustomDimensionsRequest,ListCustomDimensionsResponse,ListCustomDimensionsPagedResponse>`

listCustomMetricsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListCustomMetricsRequest,ListCustomMetricsResponse,ListCustomMetricsPagedResponse>`

listDataStreamsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListDataStreamsRequest,ListDataStreamsResponse,ListDataStreamsPagedResponse>`

listFirebaseLinksSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListFirebaseLinksRequest,ListFirebaseLinksResponse,ListFirebaseLinksPagedResponse>`

listGoogleAdsLinksSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListGoogleAdsLinksRequest,ListGoogleAdsLinksResponse,ListGoogleAdsLinksPagedResponse>`

listMeasurementProtocolSecretsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsResponse,ListMeasurementProtocolSecretsPagedResponse>`

listPropertiesSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListPropertiesRequest,ListPropertiesResponse,ListPropertiesPagedResponse>`

provisionAccountTicketSettings()

public UnaryCallSettings<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse> provisionAccountTicketSettings()

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

Returns
Type	Description
`UnaryCallSettings<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse>`

runAccessReportSettings()

public UnaryCallSettings<RunAccessReportRequest,RunAccessReportResponse> runAccessReportSettings()

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

Returns
Type	Description
`UnaryCallSettings<RunAccessReportRequest,RunAccessReportResponse>`

searchChangeHistoryEventsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsResponse,SearchChangeHistoryEventsPagedResponse>`

toBuilder()

public AnalyticsAdminServiceSettings.Builder toBuilder()

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

Returns
Type	Description
`AnalyticsAdminServiceSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateAccountSettings()

public UnaryCallSettings<UpdateAccountRequest,Account> updateAccountSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateAccountRequest,Account>`

updateCustomDimensionSettings()

public UnaryCallSettings<UpdateCustomDimensionRequest,CustomDimension> updateCustomDimensionSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateCustomDimensionRequest,CustomDimension>`

updateCustomMetricSettings()

public UnaryCallSettings<UpdateCustomMetricRequest,CustomMetric> updateCustomMetricSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateCustomMetricRequest,CustomMetric>`

updateDataRetentionSettingsSettings()

public UnaryCallSettings<UpdateDataRetentionSettingsRequest,DataRetentionSettings> updateDataRetentionSettingsSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateDataRetentionSettingsRequest,DataRetentionSettings>`

updateDataStreamSettings()

public UnaryCallSettings<UpdateDataStreamRequest,DataStream> updateDataStreamSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateDataStreamRequest,DataStream>`

updateGoogleAdsLinkSettings()

public UnaryCallSettings<UpdateGoogleAdsLinkRequest,GoogleAdsLink> updateGoogleAdsLinkSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateGoogleAdsLinkRequest,GoogleAdsLink>`

updateMeasurementProtocolSecretSettings()

public UnaryCallSettings<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> updateMeasurementProtocolSecretSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret>`

updatePropertySettings()

public UnaryCallSettings<UpdatePropertyRequest,Property> updatePropertySettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdatePropertyRequest,Property>`