Class ComputeEnvironmentConfiguration

    • Method Detail

      • name

        public final String name()

        A name for the compute environment configuration.

        Returns:
        A name for the compute environment configuration.
      • description

        public final String description()

        A description of the compute environment.

        Returns:
        A description of the compute environment.
      • supportedAuthenticationTypes

        public final List<AuthenticationType> supportedAuthenticationTypes()

        The supported authentication types for the compute environment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedAuthenticationTypes() method.

        Returns:
        The supported authentication types for the compute environment.
      • hasSupportedAuthenticationTypes

        public final boolean hasSupportedAuthenticationTypes()
        For responses, this returns true if the service returned a value for the SupportedAuthenticationTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • supportedAuthenticationTypesAsStrings

        public final List<String> supportedAuthenticationTypesAsStrings()

        The supported authentication types for the compute environment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedAuthenticationTypes() method.

        Returns:
        The supported authentication types for the compute environment.
      • hasConnectionOptions

        public final boolean hasConnectionOptions()
        For responses, this returns true if the service returned a value for the ConnectionOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • connectionOptions

        public final Map<String,​Property> connectionOptions()

        The parameters used as connection options for the compute environment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConnectionOptions() method.

        Returns:
        The parameters used as connection options for the compute environment.
      • hasConnectionPropertyNameOverrides

        public final boolean hasConnectionPropertyNameOverrides()
        For responses, this returns true if the service returned a value for the ConnectionPropertyNameOverrides property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • connectionPropertyNameOverrides

        public final Map<String,​String> connectionPropertyNameOverrides()

        The connection property name overrides for the compute environment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConnectionPropertyNameOverrides() method.

        Returns:
        The connection property name overrides for the compute environment.
      • hasConnectionOptionNameOverrides

        public final boolean hasConnectionOptionNameOverrides()
        For responses, this returns true if the service returned a value for the ConnectionOptionNameOverrides property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • connectionOptionNameOverrides

        public final Map<String,​String> connectionOptionNameOverrides()

        The connection option name overrides for the compute environment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConnectionOptionNameOverrides() method.

        Returns:
        The connection option name overrides for the compute environment.
      • hasConnectionPropertiesRequiredOverrides

        public final boolean hasConnectionPropertiesRequiredOverrides()
        For responses, this returns true if the service returned a value for the ConnectionPropertiesRequiredOverrides property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • connectionPropertiesRequiredOverrides

        public final List<String> connectionPropertiesRequiredOverrides()

        The connection properties that are required as overrides for the compute environment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConnectionPropertiesRequiredOverrides() method.

        Returns:
        The connection properties that are required as overrides for the compute environment.
      • physicalConnectionPropertiesRequired

        public final Boolean physicalConnectionPropertiesRequired()

        Indicates whether PhysicalConnectionProperties are required for the compute environment.

        Returns:
        Indicates whether PhysicalConnectionProperties are required for the compute environment.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)