ExtensionImage (Microsoft Azure SDK for Compute Management 0.7.0 API)

java.lang.Object
- com.microsoft.windowsazure.management.compute.models.ExtensionImage

Direct Known Subclasses:

ExtensionImageRegisterParameters
```
public class ExtensionImage
extends Object
```
The Extension Image.

Constructor Summary

Constructors
Constructor and Description
`ExtensionImage()` Initializes a new instance of the ExtensionImage class.
`ExtensionImage(String providerNameSpace, String type, String version)` Initializes a new instance of the ExtensionImage class with required arguments.

Method Summary

Methods
Modifier and Type	Method and Description
`ExtensionCertificateConfiguration`	`getCertificate()` Optional.
`String`	`getCompanyName()` Optional.
`String`	`getDescription()` Optional.
`URI`	`getEula()` Optional.
`ExtensionEndpointConfiguration`	`getExtensionEndpoints()` Optional.
`URI`	`getHomepageUri()` Optional.
`String`	`getHostingResources()` Optional.
`String`	`getLabel()` Optional.
`ArrayList<ExtensionLocalResourceConfiguration>`	`getLocalResources()` Optional.
`URI`	`getMediaLink()` Optional.
`URI`	`getPrivacyUri()` Optional.
`String`	`getPrivateConfigurationSchema()` Optional.
`String`	`getProviderNameSpace()` Required.
`String`	`getPublicConfigurationSchema()` Optional.
`Calendar`	`getPublishedDate()` Optional.
`String`	`getPublisherName()` Optional.
`String`	`getSampleConfig()` Optional.
`String`	`getSupportedOS()` Optional.
`String`	`getType()` Required.
`String`	`getVersion()` Required.
`Boolean`	`isBlockRoleUponFailure()` Optional.
`Boolean`	`isDisallowMajorVersionUpgrade()` Optional.
`Boolean`	`isInternalExtension()` Optional.
`Boolean`	`isJsonExtension()` Optional.
`Boolean`	`isReplicationCompleted()` Optional.
`void`	`setBlockRoleUponFailure(Boolean blockRoleUponFailureValue)` Optional.
`void`	`setCertificate(ExtensionCertificateConfiguration certificateValue)` Optional.
`void`	`setCompanyName(String companyNameValue)` Optional.
`void`	`setDescription(String descriptionValue)` Optional.
`void`	`setDisallowMajorVersionUpgrade(Boolean disallowMajorVersionUpgradeValue)` Optional.
`void`	`setEula(URI eulaValue)` Optional.
`void`	`setExtensionEndpoints(ExtensionEndpointConfiguration extensionEndpointsValue)` Optional.
`void`	`setHomepageUri(URI homepageUriValue)` Optional.
`void`	`setHostingResources(String hostingResourcesValue)` Optional.
`void`	`setIsInternalExtension(Boolean isInternalExtensionValue)` Optional.
`void`	`setIsJsonExtension(Boolean isJsonExtensionValue)` Optional.
`void`	`setLabel(String labelValue)` Optional.
`void`	`setLocalResources(ArrayList<ExtensionLocalResourceConfiguration> localResourcesValue)` Optional.
`void`	`setMediaLink(URI mediaLinkValue)` Optional.
`void`	`setPrivacyUri(URI privacyUriValue)` Optional.
`void`	`setPrivateConfigurationSchema(String privateConfigurationSchemaValue)` Optional.
`void`	`setProviderNameSpace(String providerNameSpaceValue)` Required.
`void`	`setPublicConfigurationSchema(String publicConfigurationSchemaValue)` Optional.
`void`	`setPublishedDate(Calendar publishedDateValue)` Optional.
`void`	`setPublisherName(String publisherNameValue)` Optional.
`void`	`setReplicationCompleted(Boolean replicationCompletedValue)` Optional.
`void`	`setSampleConfig(String sampleConfigValue)` Optional.
`void`	`setSupportedOS(String supportedOSValue)` Optional.
`void`	`setType(String typeValue)` Required.
`void`	`setVersion(String versionValue)` Required.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExtensionImage
```
public ExtensionImage()
```
    Initializes a new instance of the ExtensionImage class.
  - ExtensionImage
```
public ExtensionImage(String providerNameSpace,
              String type,
              String version)
```
    Initializes a new instance of the ExtensionImage class with required arguments.
- Method Detail
  - isBlockRoleUponFailure
```
public Boolean isBlockRoleUponFailure()
```
    Optional. Optional. Its value has to be 'true' or 'false' (case-sensitive) When set to 'true', the role startup will be blocked till the extension installation completes. This flag should be set to 'true' when the role cannot start without the extension being installed. If set to 'false' (default value), the role will be started without waiting for the extension installation to complete. Supported on WebRole or WorkerRole, but ignored on VmRole.
    
    Returns:
    The BlockRoleUponFailure value.
  - setBlockRoleUponFailure
```
public void setBlockRoleUponFailure(Boolean blockRoleUponFailureValue)
```
    Optional. Optional. Its value has to be 'true' or 'false' (case-sensitive) When set to 'true', the role startup will be blocked till the extension installation completes. This flag should be set to 'true' when the role cannot start without the extension being installed. If set to 'false' (default value), the role will be started without waiting for the extension installation to complete. Supported on WebRole or WorkerRole, but ignored on VmRole.
    
    Parameters:
    blockRoleUponFailureValue - The BlockRoleUponFailure value.
  - getCertificate
```
public ExtensionCertificateConfiguration getCertificate()
```
    Optional. Optional. Parameters of the the certificate for encrypting the private configuration data. Supported on WebRole or WorkerRole, but ignored on VmRole.
    
    Returns:
    The Certificate value.
  - setCertificate
```
public void setCertificate(ExtensionCertificateConfiguration certificateValue)
```
    Optional. Optional. Parameters of the the certificate for encrypting the private configuration data. Supported on WebRole or WorkerRole, but ignored on VmRole.
    
    Parameters:
    certificateValue - The Certificate value.
  - getCompanyName
```
public String getCompanyName()
```
    Optional. String property containing the name of the company/organization who publishes the extension.
    
    Returns:
    The CompanyName value.
  - setCompanyName
```
public void setCompanyName(String companyNameValue)
```
    Optional. String property containing the name of the company/organization who publishes the extension.
    
    Parameters:
    companyNameValue - The CompanyName value.
  - getDescription
```
public String getDescription()
```
    Optional. Required. Detailed description of the extension.
    
    Returns:
    The Description value.
  - setDescription
```
public void setDescription(String descriptionValue)
```
    Optional. Required. Detailed description of the extension.
    
    Parameters:
    descriptionValue - The Description value.
  - isDisallowMajorVersionUpgrade
```
public Boolean isDisallowMajorVersionUpgrade()
```
    Optional. Optional. If this is set to 'true' the extension version cannot be upgraded to from other major versions in active deployments. If the value is 'false' or nor present, the extension version can be upgraded to from any other version. Downgrade is not supported. The value has to be 'true' or 'false' (case-sensitive) if present.
    
    Returns:
    The DisallowMajorVersionUpgrade value.
  - setDisallowMajorVersionUpgrade
```
public void setDisallowMajorVersionUpgrade(Boolean disallowMajorVersionUpgradeValue)
```
    Optional. Optional. If this is set to 'true' the extension version cannot be upgraded to from other major versions in active deployments. If the value is 'false' or nor present, the extension version can be upgraded to from any other version. Downgrade is not supported. The value has to be 'true' or 'false' (case-sensitive) if present.
    
    Parameters:
    disallowMajorVersionUpgradeValue - The DisallowMajorVersionUpgrade value.
  - getEula
```
public URI getEula()
```
    Optional. Optional. URL string pointing to the EULA (End User License Agreement) of this version of extension. This is optionally specified by the third-party publishing the extension instead of Windows Azure. If the software requires any additional EULAs, a link to the EULA should be provided.
    
    Returns:
    The Eula value.
  - setEula
```
public void setEula(URI eulaValue)
```
    Optional. Optional. URL string pointing to the EULA (End User License Agreement) of this version of extension. This is optionally specified by the third-party publishing the extension instead of Windows Azure. If the software requires any additional EULAs, a link to the EULA should be provided.
    
    Parameters:
    eulaValue - The Eula value.
  - getExtensionEndpoints
```
public ExtensionEndpointConfiguration getExtensionEndpoints()
```
    Optional. Optional. Declared endpoints to automatically add to each deployment with this extension added.
    
    Returns:
    The ExtensionEndpoints value.
  - setExtensionEndpoints
```
public void setExtensionEndpoints(ExtensionEndpointConfiguration extensionEndpointsValue)
```
    Optional. Optional. Declared endpoints to automatically add to each deployment with this extension added.
    
    Parameters:
    extensionEndpointsValue - The ExtensionEndpoints value.
  - getHomepageUri
```
public URI getHomepageUri()
```
    Optional. Optional. URL string pointing to homepage of this version of extension. This is optionally specified by the third-party publishing the extension instead of Azure. The homepage should have usage information and contact information for customer support.
    
    Returns:
    The HomepageUri value.
  - setHomepageUri
```
public void setHomepageUri(URI homepageUriValue)
```
    Optional. Optional. URL string pointing to homepage of this version of extension. This is optionally specified by the third-party publishing the extension instead of Azure. The homepage should have usage information and contact information for customer support.
    
    Parameters:
    homepageUriValue - The HomepageUri value.
  - getHostingResources
```
public String getHostingResources()
```
    Optional. Required. The supported hosting resources. It must contain 'WebRole' and/or 'WorkerRole'. E.g. 'WebRole|WorkerRole' or 'WebRole|WorkerRole|VmRole'.
    
    Returns:
    The HostingResources value.
  - setHostingResources
```
public void setHostingResources(String hostingResourcesValue)
```
    Optional. Required. The supported hosting resources. It must contain 'WebRole' and/or 'WorkerRole'. E.g. 'WebRole|WorkerRole' or 'WebRole|WorkerRole|VmRole'.
    
    Parameters:
    hostingResourcesValue - The HostingResources value.
  - isInternalExtension
```
public Boolean isInternalExtension()
```
    Optional. Optional. If this is set to 'true' the extension is not visible for public use, i.e. being returned from list API's. It can be still accessed by referring to the ProviderNamespace, Type & Version combo. Therefore an internal extension is intended only for testing purpose. Its value has to be 'true' or 'false' (case-sensitive) if present.
    
    Returns:
    The IsInternalExtension value.
  - setIsInternalExtension
```
public void setIsInternalExtension(Boolean isInternalExtensionValue)
```
    Optional. Optional. If this is set to 'true' the extension is not visible for public use, i.e. being returned from list API's. It can be still accessed by referring to the ProviderNamespace, Type & Version combo. Therefore an internal extension is intended only for testing purpose. Its value has to be 'true' or 'false' (case-sensitive) if present.
    
    Parameters:
    isInternalExtensionValue - The IsInternalExtension value.
  - isJsonExtension
```
public Boolean isJsonExtension()
```
    Optional. Optional. If this is set to 'true' the extension is expected to receive JSON based configuration. If this is set to 'false' the extension is expected to receive XML based configuration. Its value has to be 'true' or 'false' (case-sensitive) if present.
    
    Returns:
    The IsJsonExtension value.
  - setIsJsonExtension
```
public void setIsJsonExtension(Boolean isJsonExtensionValue)
```
    Optional. Optional. If this is set to 'true' the extension is expected to receive JSON based configuration. If this is set to 'false' the extension is expected to receive XML based configuration. Its value has to be 'true' or 'false' (case-sensitive) if present.
    
    Parameters:
    isJsonExtensionValue - The IsJsonExtension value.
  - getLabel
```
public String getLabel()
```
    Optional. Required. A one line label of the extension.
    
    Returns:
    The Label value.
  - setLabel
```
public void setLabel(String labelValue)
```
    Optional. Required. A one line label of the extension.
    
    Parameters:
    labelValue - The Label value.
  - getLocalResources
```
public ArrayList<ExtensionLocalResourceConfiguration> getLocalResources()
```
    Optional. Declared local resources used inside guest VM by the extension. Optional.
    
    Returns:
    The LocalResources value.
  - setLocalResources
```
public void setLocalResources(ArrayList<ExtensionLocalResourceConfiguration> localResourcesValue)
```
    Optional. Declared local resources used inside guest VM by the extension. Optional.
    
    Parameters:
    localResourcesValue - The LocalResources value.
  - getMediaLink
```
public URI getMediaLink()
```
    Optional. Required. URI string pointing to the ZIP package of the extension. The ZIP package has to include the extension executable and other supporting files, and the PluginManifest.xml manifest. MediaLink value must point to a URL (either Http or Https) in a Azure blob storage and is downloadable. Windows Azure will copy the extension package from this source location and replicate it to all regions. The typical time for replication to complete is 20 minutes.
    
    Returns:
    The MediaLink value.
  - setMediaLink
```
public void setMediaLink(URI mediaLinkValue)
```
    Optional. Required. URI string pointing to the ZIP package of the extension. The ZIP package has to include the extension executable and other supporting files, and the PluginManifest.xml manifest. MediaLink value must point to a URL (either Http or Https) in a Azure blob storage and is downloadable. Windows Azure will copy the extension package from this source location and replicate it to all regions. The typical time for replication to complete is 20 minutes.
    
    Parameters:
    mediaLinkValue - The MediaLink value.
  - getPrivacyUri
```
public URI getPrivacyUri()
```
    Optional. Optional. URL string pointing to privacy document of this version of extension. This is optionally specified by the third-party publishing the extension instead of Azure. If the software collects any data and transfers out the guest VM, then an additional privacy document might be needed.
    
    Returns:
    The PrivacyUri value.
  - setPrivacyUri
```
public void setPrivacyUri(URI privacyUriValue)
```
    Optional. Optional. URL string pointing to privacy document of this version of extension. This is optionally specified by the third-party publishing the extension instead of Azure. If the software collects any data and transfers out the guest VM, then an additional privacy document might be needed.
    
    Parameters:
    privacyUriValue - The PrivacyUri value.
  - getPrivateConfigurationSchema
```
public String getPrivateConfigurationSchema()
```
    Optional. Optional. The XSD schema of private configuration data.
    
    Returns:
    The PrivateConfigurationSchema value.
  - setPrivateConfigurationSchema
```
public void setPrivateConfigurationSchema(String privateConfigurationSchemaValue)
```
    Optional. Optional. The XSD schema of private configuration data.
    
    Parameters:
    privateConfigurationSchemaValue - The PrivateConfigurationSchema value.
  - getProviderNameSpace
```
public String getProviderNameSpace()
```
    Required. Required. The provider namespace of the extension.
    
    Returns:
    The ProviderNameSpace value.
  - setProviderNameSpace
```
public void setProviderNameSpace(String providerNameSpaceValue)
```
    Required. Required. The provider namespace of the extension.
    
    Parameters:
    providerNameSpaceValue - The ProviderNameSpace value.
  - getPublicConfigurationSchema
```
public String getPublicConfigurationSchema()
```
    Optional. Optional. The XSD schema of public configuration data.
    
    Returns:
    The PublicConfigurationSchema value.
  - setPublicConfigurationSchema
```
public void setPublicConfigurationSchema(String publicConfigurationSchemaValue)
```
    Optional. Optional. The XSD schema of public configuration data.
    
    Parameters:
    publicConfigurationSchemaValue - The PublicConfigurationSchema value.
  - getPublishedDate
```
public Calendar getPublishedDate()
```
    Optional. Publisher can set it to any arbitrary date, and this is only for display purpose. If not specified by publisher, Azure will automatically assign the UTC time when the extension request was received.
    
    Returns:
    The PublishedDate value.
  - setPublishedDate
```
public void setPublishedDate(Calendar publishedDateValue)
```
    Optional. Publisher can set it to any arbitrary date, and this is only for display purpose. If not specified by publisher, Azure will automatically assign the UTC time when the extension request was received.
    
    Parameters:
    publishedDateValue - The PublishedDate value.
  - getPublisherName
```
public String getPublisherName()
```
    Optional. Optional. Publisher name text.
    
    Returns:
    The PublisherName value.
  - setPublisherName
```
public void setPublisherName(String publisherNameValue)
```
    Optional. Optional. Publisher name text.
    
    Parameters:
    publisherNameValue - The PublisherName value.
  - isReplicationCompleted
```
public Boolean isReplicationCompleted()
```
    Optional. Indicates whether this version of extension has been replicated to all regions or not. If true, then the given extension version can be used in creating or updating deployments. Otherwise, the given extension version might cause failure in creating or updating deployments. The typical time is 20 minutes for a newly-registered or newly-updated extension to replicate completely by Azure.
    
    Returns:
    The ReplicationCompleted value.
  - setReplicationCompleted
```
public void setReplicationCompleted(Boolean replicationCompletedValue)
```
    Optional. Indicates whether this version of extension has been replicated to all regions or not. If true, then the given extension version can be used in creating or updating deployments. Otherwise, the given extension version might cause failure in creating or updating deployments. The typical time is 20 minutes for a newly-registered or newly-updated extension to replicate completely by Azure.
    
    Parameters:
    replicationCompletedValue - The ReplicationCompleted value.
  - getSampleConfig
```
public String getSampleConfig()
```
    Optional. Optional. A sample configuration for the extension. It can be downloaded by users, and the user can replace with customized input parameters. The sample configuration should be sufficiently commented. If configuration data are in XML format, then the XML document-level element must be 'Configuration', and the optional public configuration data corresponds to a child element of 'PublicConfig', and the optional private configuration data corresponds to a child element of 'PrivateConfig'. The sample configuration data should be validated against public and private configuration schema by the publisher.
    
    Returns:
    The SampleConfig value.
  - setSampleConfig
```
public void setSampleConfig(String sampleConfigValue)
```
    Optional. Optional. A sample configuration for the extension. It can be downloaded by users, and the user can replace with customized input parameters. The sample configuration should be sufficiently commented. If configuration data are in XML format, then the XML document-level element must be 'Configuration', and the optional public configuration data corresponds to a child element of 'PublicConfig', and the optional private configuration data corresponds to a child element of 'PrivateConfig'. The sample configuration data should be validated against public and private configuration schema by the publisher.
    
    Parameters:
    sampleConfigValue - The SampleConfig value.
  - getSupportedOS
```
public String getSupportedOS()
```
    Optional. String property indicating the OS which the extension supports. Current values are 'Windows' or 'Linux'.
    
    Returns:
    The SupportedOS value.
  - setSupportedOS
```
public void setSupportedOS(String supportedOSValue)
```
    Optional. String property indicating the OS which the extension supports. Current values are 'Windows' or 'Linux'.
    
    Parameters:
    supportedOSValue - The SupportedOS value.
  - getType
```
public String getType()
```
    Required. Required. The type of the extension.
    
    Returns:
    The Type value.
  - setType
```
public void setType(String typeValue)
```
    Required. Required. The type of the extension.
    
    Parameters:
    typeValue - The Type value.
  - getVersion
```
public String getVersion()
```
    Required. Required. The version of the extension.
    
    Returns:
    The Version value.
  - setVersion
```
public void setVersion(String versionValue)
```
    Required. Required. The version of the extension.
    
    Parameters:
    versionValue - The Version value.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class ExtensionImage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExtensionImage

ExtensionImage

Method Detail

isBlockRoleUponFailure

setBlockRoleUponFailure

getCertificate

setCertificate

getCompanyName

setCompanyName

getDescription

setDescription

isDisallowMajorVersionUpgrade

setDisallowMajorVersionUpgrade

getEula

setEula

getExtensionEndpoints

setExtensionEndpoints

getHomepageUri

setHomepageUri

getHostingResources

setHostingResources

isInternalExtension

setIsInternalExtension

isJsonExtension

setIsJsonExtension

getLabel

setLabel

getLocalResources

setLocalResources

getMediaLink

setMediaLink

getPrivacyUri

setPrivacyUri

getPrivateConfigurationSchema

setPrivateConfigurationSchema

getProviderNameSpace

setProviderNameSpace

getPublicConfigurationSchema

setPublicConfigurationSchema

getPublishedDate

setPublishedDate

getPublisherName

setPublisherName

isReplicationCompleted

setReplicationCompleted

getSampleConfig

setSampleConfig

getSupportedOS

setSupportedOS

getType

setType

getVersion

setVersion