Class OrgPolicyStubSettings (2.1.2) 

public class OrgPolicyStubSettings extends StubSettings<OrgPolicyStubSettings>

Settings class to configure an instance of OrgPolicyStub.

The default instance has everything set to sensible defaults:

  • The default service address (orgpolicy.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 getPolicy to 30 seconds:


 OrgPolicyStubSettings.Builder orgPolicySettingsBuilder = OrgPolicyStubSettings.newBuilder();
 orgPolicySettingsBuilder
     .getPolicySettings()
     .setRetrySettings(
         orgPolicySettingsBuilder
             .getPolicySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OrgPolicyStubSettings orgPolicySettings = orgPolicySettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > OrgPolicyStubSettings

Static Methods

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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static OrgPolicyStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
OrgPolicyStubSettings.Builder

newBuilder(ClientContext clientContext)

public static OrgPolicyStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
OrgPolicyStubSettings.Builder

Constructors

OrgPolicyStubSettings(OrgPolicyStubSettings.Builder settingsBuilder)

protected OrgPolicyStubSettings(OrgPolicyStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderOrgPolicyStubSettings.Builder

Methods

createPolicySettings()

public UnaryCallSettings<CreatePolicyRequest,Policy> createPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreatePolicyRequest,Policy>

createStub()

public OrgPolicyStub createStub()
Returns
TypeDescription
OrgPolicyStub
Exceptions
TypeDescription
IOException

deletePolicySettings()

public UnaryCallSettings<DeletePolicyRequest,Empty> deletePolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeletePolicyRequest,Empty>

getEffectivePolicySettings()

public UnaryCallSettings<GetEffectivePolicyRequest,Policy> getEffectivePolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEffectivePolicyRequest,Policy>

getPolicySettings()

public UnaryCallSettings<GetPolicyRequest,Policy> getPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetPolicyRequest,Policy>

listConstraintsSettings()

public PagedCallSettings<ListConstraintsRequest,ListConstraintsResponse,OrgPolicyClient.ListConstraintsPagedResponse> listConstraintsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListConstraintsRequest,ListConstraintsResponse,ListConstraintsPagedResponse>

listPoliciesSettings()

public PagedCallSettings<ListPoliciesRequest,ListPoliciesResponse,OrgPolicyClient.ListPoliciesPagedResponse> listPoliciesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListPoliciesRequest,ListPoliciesResponse,ListPoliciesPagedResponse>

toBuilder()

public OrgPolicyStubSettings.Builder toBuilder()

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

Returns
TypeDescription
OrgPolicyStubSettings.Builder
Overrides

updatePolicySettings()

public UnaryCallSettings<UpdatePolicyRequest,Policy> updatePolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdatePolicyRequest,Policy>