Class AnalyticsAdminServiceSettings (0.31.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

Static Methods

create(AnalyticsAdminServiceStubSettings stub)

public static final AnalyticsAdminServiceSettings create(AnalyticsAdminServiceStubSettings stub)
Parameter
NameDescription
stubAnalyticsAdminServiceStubSettings
Returns
TypeDescription
AnalyticsAdminServiceSettings
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 gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns a new gRPC builder for this class.

Returns
TypeDescription
AnalyticsAdminServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static AnalyticsAdminServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
AnalyticsAdminServiceSettings.Builder

newHttpJsonBuilder()

public static AnalyticsAdminServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
AnalyticsAdminServiceSettings.Builder

Constructors

AnalyticsAdminServiceSettings(AnalyticsAdminServiceSettings.Builder settingsBuilder)

protected AnalyticsAdminServiceSettings(AnalyticsAdminServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderAnalyticsAdminServiceSettings.Builder

Methods

acknowledgeUserDataCollectionSettings()

public UnaryCallSettings<AcknowledgeUserDataCollectionRequest,AcknowledgeUserDataCollectionResponse> acknowledgeUserDataCollectionSettings()

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

Returns
TypeDescription
UnaryCallSettings<AcknowledgeUserDataCollectionRequest,AcknowledgeUserDataCollectionResponse>

archiveCustomDimensionSettings()

public UnaryCallSettings<ArchiveCustomDimensionRequest,Empty> archiveCustomDimensionSettings()

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

Returns
TypeDescription
UnaryCallSettings<ArchiveCustomDimensionRequest,Empty>

archiveCustomMetricSettings()

public UnaryCallSettings<ArchiveCustomMetricRequest,Empty> archiveCustomMetricSettings()

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

Returns
TypeDescription
UnaryCallSettings<ArchiveCustomMetricRequest,Empty>

createConversionEventSettings()

public UnaryCallSettings<CreateConversionEventRequest,ConversionEvent> createConversionEventSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateConversionEventRequest,ConversionEvent>

createCustomDimensionSettings()

public UnaryCallSettings<CreateCustomDimensionRequest,CustomDimension> createCustomDimensionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCustomDimensionRequest,CustomDimension>

createCustomMetricSettings()

public UnaryCallSettings<CreateCustomMetricRequest,CustomMetric> createCustomMetricSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCustomMetricRequest,CustomMetric>

createDataStreamSettings()

public UnaryCallSettings<CreateDataStreamRequest,DataStream> createDataStreamSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateDataStreamRequest,DataStream>

createFirebaseLinkSettings()

public UnaryCallSettings<CreateFirebaseLinkRequest,FirebaseLink> createFirebaseLinkSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateFirebaseLinkRequest,FirebaseLink>

createGoogleAdsLinkSettings()

public UnaryCallSettings<CreateGoogleAdsLinkRequest,GoogleAdsLink> createGoogleAdsLinkSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateGoogleAdsLinkRequest,GoogleAdsLink>

createMeasurementProtocolSecretSettings()

public UnaryCallSettings<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> createMeasurementProtocolSecretSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret>

createPropertySettings()

public UnaryCallSettings<CreatePropertyRequest,Property> createPropertySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreatePropertyRequest,Property>

deleteAccountSettings()

public UnaryCallSettings<DeleteAccountRequest,Empty> deleteAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAccountRequest,Empty>

deleteConversionEventSettings()

public UnaryCallSettings<DeleteConversionEventRequest,Empty> deleteConversionEventSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteConversionEventRequest,Empty>

deleteDataStreamSettings()

public UnaryCallSettings<DeleteDataStreamRequest,Empty> deleteDataStreamSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteDataStreamRequest,Empty>

deleteFirebaseLinkSettings()

public UnaryCallSettings<DeleteFirebaseLinkRequest,Empty> deleteFirebaseLinkSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteFirebaseLinkRequest,Empty>

deleteGoogleAdsLinkSettings()

public UnaryCallSettings<DeleteGoogleAdsLinkRequest,Empty> deleteGoogleAdsLinkSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteGoogleAdsLinkRequest,Empty>

deleteMeasurementProtocolSecretSettings()

public UnaryCallSettings<DeleteMeasurementProtocolSecretRequest,Empty> deleteMeasurementProtocolSecretSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteMeasurementProtocolSecretRequest,Empty>

deletePropertySettings()

public UnaryCallSettings<DeletePropertyRequest,Property> deletePropertySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeletePropertyRequest,Property>

getAccountSettings()

public UnaryCallSettings<GetAccountRequest,Account> getAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAccountRequest,Account>

getConversionEventSettings()

public UnaryCallSettings<GetConversionEventRequest,ConversionEvent> getConversionEventSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetConversionEventRequest,ConversionEvent>

getCustomDimensionSettings()

public UnaryCallSettings<GetCustomDimensionRequest,CustomDimension> getCustomDimensionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCustomDimensionRequest,CustomDimension>

getCustomMetricSettings()

public UnaryCallSettings<GetCustomMetricRequest,CustomMetric> getCustomMetricSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCustomMetricRequest,CustomMetric>

getDataRetentionSettingsSettings()

public UnaryCallSettings<GetDataRetentionSettingsRequest,DataRetentionSettings> getDataRetentionSettingsSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDataRetentionSettingsRequest,DataRetentionSettings>

getDataSharingSettingsSettings()

public UnaryCallSettings<GetDataSharingSettingsRequest,DataSharingSettings> getDataSharingSettingsSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDataSharingSettingsRequest,DataSharingSettings>

getDataStreamSettings()

public UnaryCallSettings<GetDataStreamRequest,DataStream> getDataStreamSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDataStreamRequest,DataStream>

getMeasurementProtocolSecretSettings()

public UnaryCallSettings<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret> getMeasurementProtocolSecretSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret>

getPropertySettings()

public UnaryCallSettings<GetPropertyRequest,Property> getPropertySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetPropertyRequest,Property>

listAccountSummariesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListAccountSummariesRequest,ListAccountSummariesResponse,ListAccountSummariesPagedResponse>

listAccountsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListAccountsRequest,ListAccountsResponse,ListAccountsPagedResponse>

listConversionEventsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListConversionEventsRequest,ListConversionEventsResponse,ListConversionEventsPagedResponse>

listCustomDimensionsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListCustomDimensionsRequest,ListCustomDimensionsResponse,ListCustomDimensionsPagedResponse>

listCustomMetricsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListCustomMetricsRequest,ListCustomMetricsResponse,ListCustomMetricsPagedResponse>

listDataStreamsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListDataStreamsRequest,ListDataStreamsResponse,ListDataStreamsPagedResponse>

listFirebaseLinksSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListFirebaseLinksRequest,ListFirebaseLinksResponse,ListFirebaseLinksPagedResponse>

listGoogleAdsLinksSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListGoogleAdsLinksRequest,ListGoogleAdsLinksResponse,ListGoogleAdsLinksPagedResponse>

listMeasurementProtocolSecretsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsResponse,ListMeasurementProtocolSecretsPagedResponse>

listPropertiesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListPropertiesRequest,ListPropertiesResponse,ListPropertiesPagedResponse>

provisionAccountTicketSettings()

public UnaryCallSettings<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse> provisionAccountTicketSettings()

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

Returns
TypeDescription
UnaryCallSettings<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse>

runAccessReportSettings()

public UnaryCallSettings<RunAccessReportRequest,RunAccessReportResponse> runAccessReportSettings()

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

Returns
TypeDescription
UnaryCallSettings<RunAccessReportRequest,RunAccessReportResponse>

searchChangeHistoryEventsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsResponse,SearchChangeHistoryEventsPagedResponse>

toBuilder()

public AnalyticsAdminServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
AnalyticsAdminServiceSettings.Builder
Overrides

updateAccountSettings()

public UnaryCallSettings<UpdateAccountRequest,Account> updateAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateAccountRequest,Account>

updateCustomDimensionSettings()

public UnaryCallSettings<UpdateCustomDimensionRequest,CustomDimension> updateCustomDimensionSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCustomDimensionRequest,CustomDimension>

updateCustomMetricSettings()

public UnaryCallSettings<UpdateCustomMetricRequest,CustomMetric> updateCustomMetricSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCustomMetricRequest,CustomMetric>

updateDataRetentionSettingsSettings()

public UnaryCallSettings<UpdateDataRetentionSettingsRequest,DataRetentionSettings> updateDataRetentionSettingsSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateDataRetentionSettingsRequest,DataRetentionSettings>

updateDataStreamSettings()

public UnaryCallSettings<UpdateDataStreamRequest,DataStream> updateDataStreamSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateDataStreamRequest,DataStream>

updateGoogleAdsLinkSettings()

public UnaryCallSettings<UpdateGoogleAdsLinkRequest,GoogleAdsLink> updateGoogleAdsLinkSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateGoogleAdsLinkRequest,GoogleAdsLink>

updateMeasurementProtocolSecretSettings()

public UnaryCallSettings<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> updateMeasurementProtocolSecretSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret>

updatePropertySettings()

public UnaryCallSettings<UpdatePropertyRequest,Property> updatePropertySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdatePropertyRequest,Property>