PureStorage.Rest.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>PureStorage.Rest</name>
    </assembly>
    <members>
        <member name="T:PureStorage.Rest.PureInternalsOperationsStubImpl">
            <summary>
            Class representing the operations on a protection group.
            </summary>
        </member>
        <member name="T:PureStorage.Rest.MetricTimeRange">
            <summary>
            Class representing all the supported time ranges.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.MetricTimeRange.PT1H">
            <summary>
            Gets the 1-hour time range.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.MetricTimeRange.PT3H">
            <summary>
            Gets the 3-hour time range.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.MetricTimeRange.P24H">
            <summary>
            Gets the 24-hour time range.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.MetricTimeRange.P7D">
            <summary>
            Gets the 7-day time range.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.MetricTimeRange.P30D">
            <summary>
            Gets the 30-day time range.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.MetricTimeRange.P90D">
            <summary>
            Gets the 90-day time range.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.MetricTimeRange.P1Y">
            <summary>
            Gets the 1-year time range.
            </summary>
        </member>
        <member name="T:PureStorage.Rest.PureArrayOperationsStubImpl">
            <summary>
            Class representing the array operations.
            </summary>
        </member>
        <member name="M:PureStorage.Rest.PureArrayOperationsStubImpl.GetId(System.String,System.Boolean,System.String)">
            <summary>
            Gets the id of the array.
            </summary>
        </member>
        <member name="M:PureStorage.Rest.PureArrayOperationsStubImpl.SetPhoneHomeStatus(System.String,System.Boolean,PureStorage.Rest.PureArrayStatus,System.String)">
            <summary>
            Sets the phonehome status.
            </summary>
        </member>
        <member name="M:PureStorage.Rest.PureArrayOperationsStubImpl.SetConsoleLock(System.String,System.Boolean,PureStorage.Rest.PureArrayStatus,System.String)">
            <summary>
            Sets the status of the console.
            </summary>
        </member>
        <member name="M:PureStorage.Rest.PureArrayOperationsStubImpl.SetSyslogServers(System.String,System.Boolean,System.Collections.Generic.IList{System.String},System.String)">
            <summary>
            Sets the syslog servers.
            </summary>
        </member>
        <member name="T:PureStorage.Rest.PureProtectionGroupOperationsStubImpl">
            <summary>
            Class representing the operations on a protection group.
            </summary>
        </member>
        <member name="M:PureStorage.Rest.PureProtectionGroupOperationsStubImpl.SetSchedule(System.String,System.Boolean,System.String,System.Collections.Generic.IList{PureStorage.Rest.Blackout},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String)">
            <summary>
            Sets the replication and snapshot schedule in the protection group.
            </summary>
            <returns>The schedule.</returns>
        </member>
        <member name="M:PureStorage.Rest.PureProtectionGroupOperationsStubImpl.CreateSnapshot(System.String,System.Boolean,System.String,System.Boolean,System.Boolean,System.Boolean,System.String,System.String)">
            <summary>
            Create snapshot for the protection group.
            </summary>
            <param name="api_version">The version of the api.</param>
            <param name="offline">Whether to only create the request</param>
            <param name="protectionGroupName">The protection group.</param>
            <param name="applyRetention">Apply retention to the snapshots created.</param>
            <param name="replicateNow">Replicate the snapshots immediately.</param>
            <param name="replicate">Replicate to each allowed target after all earlier replication sessions for the same protection group have been completed to that target.</param>
            <param name="suffix">Suffix for the snapshots.</param>
            <param name="operationID">Supplied by the caller to correlate multiple sub-operations.</param>
            <returns>The snapshot.</returns>
        </member>
        <member name="M:PureStorage.Rest.PureProtectionGroupOperationsStubImpl.CreateSnapshot(System.String,System.Boolean,System.Collections.Generic.IList{System.String},System.Boolean,System.Boolean,System.Boolean,System.String,System.String)">
            <summary>
            Create snapshot for the protection group.
            </summary>
            <param name="api_version">The version of the api.</param>
            <param name="offline">Whether to only create the request</param>
            <param name="protectionGroupNames">The protection groups.</param>
            <param name="applyRetention">Apply retention to the snapshots created.</param>
            <param name="replicateNow">Replicate the snapshots immediately.</param>
            <param name="replicate">Replicate to each allowed target after all earlier replication sessions for the same protection group have been completed to that target.</param>
            <param name="suffix">Suffix for the snapshots.</param>
            <param name="operationID">Supplied by the caller to correlate multiple sub-operations.</param>
            <returns>The snapshot.</returns>
        </member>
        <member name="M:PureStorage.Rest.PureProtectionGroupOperationsStubImpl.GetChildSnapshots(System.String,System.Boolean,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String)">
            <summary>
            Gets the volume snapshots that are part of the protection group or protection group snapshot
            </summary>
            <param name="api_version"></param>
            <param name="offline"></param>
            <param name="pGroupSnapshotName">protection group or protection group snapshot</param>
            <param name="filter"></param>
            <param name="sort"></param>
            <param name="startElement"></param>
            <param name="pageSize"></param>
            <param name="operationID"></param>
            <returns></returns>
        </member>
        <member name="F:PureStorage.Rest.PureSizeUnit.S">
            <summary>
            512-byte
            </summary>
        </member>
        <member name="F:PureStorage.Rest.PureSizeUnit.KiB">
            <summary>
            Kibibyte
            </summary>
        </member>
        <member name="F:PureStorage.Rest.PureSizeUnit.MiB">
            <summary>
            Mebibyte
            </summary>
        </member>
        <member name="F:PureStorage.Rest.PureSizeUnit.GiB">
            <summary>
            Gibibyte
            </summary>
        </member>
        <member name="F:PureStorage.Rest.PureSizeUnit.TiB">
            <summary>
            Tebibyte
            </summary>
        </member>
        <member name="F:PureStorage.Rest.PureSizeUnit.PiB">
            <summary>
            Pebibyte
            </summary>
        </member>
        <member name="T:PureStorage.Rest.PureVolumeOperationsStubImpl">
            <summary>
            Implementation of Volume stubs.
            </summary>
        </member>
        <member name="M:PureStorage.Rest.PureVolumeOperationsStubImpl.Create(System.String,System.Boolean,System.String,System.Int64,System.String,System.Boolean,System.Nullable{System.Int64},System.Nullable{System.Int32},System.String)">
            <summary>
            Create a volume.
            </summary>
            <param name="api_version">The version of the api.</param>
            <param name="offline">Whether to only create the request.</param>
            <param name="volumeName">The name of the volume.</param>
            <param name="size">The size of the volume.</param>
            <param name="unit">The unit of the volume size.</param>
            <param name="overwrite">Overwrite existing volume if set to true.</param>
            <param name="bandwidthLimit">Bandwidth limit for volume IO.</param>
            <param name="iopsLimit">Bandwidth limit for volume IO.</param>
            <param name="operationID">Supplied by the caller to correlate multiple sub-operations.</param>
            <returns>The volume wrapped in a RequestResult object.</returns>
        </member>
        <member name="T:PureStorage.Rest.PureNamespacedPropertyAttribute">
            <summary>
            Attribute describing a request to the rest API.
            </summary>
        </member>
        <member name="F:PureStorage.Rest.PureOperations.NAMESPACE_REGEX">
            <summary>
            Regex describing how to determine if the name breaks backwards compat
            </summary>
        </member>
        <member name="T:PureStorage.Rest.PureNamespacedResponseAttribute">
            <summary>
            Attribute describing a request to the rest API.
            </summary>
        </member>
        <member name="T:PureStorage.Rest.PureRestClient">
            <summary>
            The client to the REST API
            </summary>
        </member>
        <member name="M:PureStorage.Rest.PureRestClient.Create(System.String,System.String,System.String,System.String,PureStorage.Rest.PureRestClientOptions,PureStorage.Rest.PhoneHomeManagerConfig)">
            <summary>
            Create a rest client
            </summary>
            <param name="username">The username for the array</param>
            <param name="password">The password</param>
            <param name="apiEndpoint">The API endpoint, e.g. "192.168.231.101" </param>
            <param name="version">Version to use. Pass in null if you need to use the latest one supported. </param>
            <param name="options">The rest client options.</param>
            <param name="phConfig">The configuration settings for the PhoneHome logger</param>
            <returns></returns>
        </member>
        <member name="M:PureStorage.Rest.PureRestClient.Create(System.String,System.String,System.String,PureStorage.Rest.PureRestClientOptions,PureStorage.Rest.PhoneHomeManagerConfig)">
            <summary>
            Create a rest client
            </summary>
            <param name="apiToken">The apiToken for the array</param>
            <param name="apiEndpoint">The API endpoint, e.g. "192.168.231.101" </param>
            <param name="version">Version to use. Pass in null if you need to use the latest one supported. </param>
            <param name="options">The rest client options.</param>
            <param name="phConfig">The configuration settings for the PhoneHome logger</param>
            <returns></returns>
        </member>
        <member name="M:PureStorage.Rest.PureRestClient.StartOperation(System.String)">
            <summary>
            Sets the X-Operation-Id header sent with each request.
            This is used to link multiple REST operations as part of the same client task.
            </summary>
            <param name="operationID"></param>
            <returns>The operationID</returns>
        </member>
        <member name="M:PureStorage.Rest.PureRestClient.EndOperation">
            <summary>
            Removes the X-Operation-Id header being sent with each request.
            </summary>
        </member>
        <member name="M:PureStorage.Rest.PureRestClient.GetEndPointAbsoluteURIString(System.String)">
             <summary>
             Return a valid URL from the input endpoint
             
             Acceptable:
               Valid IPv4 or IPv6 address
               Valid absolute URI with http or https schemes
               Valid DNS hostname string
             Not acceptable:
               IP address but not IPv4 or IPv6
               Hostname that is not a DNS host type
               URI with invalid scheme, hostname or not absolute
             </summary>
             <param name="inputEndPoint"></param>
             <returns></returns>
        </member>
        <member name="M:PureStorage.Rest.PureRestClient.GetEndPointAbsoluteURI(System.String)">
             <summary>
             Return a valid URL from the input endpoint
             
             Acceptable:
               Valid IPv4 or IPv6 address
               Valid absolute URI with http or https schemes
               Valid DNS hostname string
             Not acceptable:
               IP address but not IPv4 or IPv6
               Hostname that is not a DNS host type
               URI with invalid scheme, hostname or not absolute
             </summary>
             <param name="inputEndPoint"></param>
             <returns></returns>
        </member>
        <member name="M:PureStorage.Rest.PureRestClient.GetEndPointForFlashArray(System.String)">
            <summary>
            We will use https as the method and /api as the base relative path
            </summary>
            <param name="inputEndPoint"></param>
            <returns></returns>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Array">
            <summary>
            Gets the array Operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Volumes">
            <summary>
            Gets the volume operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.VolumeGroups">
            <summary>
            Gets the vgroup operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Hosts">
            <summary>
            Gets the host operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.HostGroups">
            <summary>
            Gets the host group operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.ProtectionGroups">
            <summary>
            Gets the protection group operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Pods">
            <summary>
            Gets the pod operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Ports">
            <summary>
            Gets the port operations.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Alerts">
            <summary>
            Gets the alert operations.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Messages">
            <summary>
            Gets the message operations.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.SNMP">
            <summary>
            Gets the SNMP operations.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Certificates">
            <summary>
            Gets the certificate operations.
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Networking">
            <summary>
            Gets the networking operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Hardware">
            <summary>
            Gets the hardware operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Internals">
            <summary>
            Gets the internal operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Users">
            <summary>
            Gets the user operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.KMIP">
            <summary>
            Gets the KMIP operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Offload">
            <summary>
            Gets the Offload operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.Smtp">
            <summary>
            Gets the Smtp operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.SoftwareApp">
            <summary>
            Gets the SoftwareApp operations
            </summary>
        </member>
        <member name="P:PureStorage.Rest.PureRestClient.MaintenanceWindow">
            <summary>
            Gets the Maintenance Window operations
            </summary>
        </member>
    </members>
</doc>