Package software.amazon.awssdk.services.glue.model

Class PutResourcePolicyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.glue.model.GlueRequest
software.amazon.awssdk.services.glue.model.PutResourcePolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutResourcePolicyRequest extends GlueRequest implements ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

  • Method Details

    • policyInJson

      public final String policyInJson()

      Contains the policy document to set, in JSON format.

      Returns:
      Contains the policy document to set, in JSON format.

    • resourceArn

      public final String resourceArn()

      Do not use. For internal use only.

      Returns:
      Do not use. For internal use only.

    • policyHashCondition

      public final String policyHashCondition()

      The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.

      Returns:
      The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.

    • policyExistsCondition

      public final ExistCondition policyExistsCondition()

      A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call does not depend on the existence of a policy.

      If the service returns an enum value that is not available in the current SDK version, policyExistsCondition will return ExistCondition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyExistsConditionAsString().

      Returns:
      A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call does not depend on the existence of a policy.
      See Also:

    • policyExistsConditionAsString

      public final String policyExistsConditionAsString()

      A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call does not depend on the existence of a policy.

      If the service returns an enum value that is not available in the current SDK version, policyExistsCondition will return ExistCondition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyExistsConditionAsString().

      Returns:
      A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call does not depend on the existence of a policy.
      See Also:

    • enableHybrid

      public final EnableHybridValues enableHybrid()

      If 'TRUE', indicates that you are using both methods to grant cross-account access to Data Catalog resources:

      • By directly updating the resource policy with PutResourePolicy

      • By using the Grant permissions command on the Amazon Web Services Management Console.

      Must be set to 'TRUE' if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is 'FALSE'.

      If the service returns an enum value that is not available in the current SDK version, enableHybrid will return EnableHybridValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from enableHybridAsString().

      Returns:
      If 'TRUE', indicates that you are using both methods to grant cross-account access to Data Catalog resources:

      • By directly updating the resource policy with PutResourePolicy

      • By using the Grant permissions command on the Amazon Web Services Management Console.

      Must be set to 'TRUE' if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is 'FALSE'.

      See Also:

    • enableHybridAsString

      public final String enableHybridAsString()

      If 'TRUE', indicates that you are using both methods to grant cross-account access to Data Catalog resources:

      • By directly updating the resource policy with PutResourePolicy

      • By using the Grant permissions command on the Amazon Web Services Management Console.

      Must be set to 'TRUE' if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is 'FALSE'.

      If the service returns an enum value that is not available in the current SDK version, enableHybrid will return EnableHybridValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from enableHybridAsString().

      Returns:
      If 'TRUE', indicates that you are using both methods to grant cross-account access to Data Catalog resources:

      • By directly updating the resource policy with PutResourePolicy

      • By using the Grant permissions command on the Amazon Web Services Management Console.

      Must be set to 'TRUE' if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is 'FALSE'.

      See Also:

    • toBuilder

      public PutResourcePolicyRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>
      Specified by:
      toBuilder in class GlueRequest
      Returns:
      a builder for type T

    • builder

      public static PutResourcePolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutResourcePolicyRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.