188 строки
16 KiB
YAML
188 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.support.models.Communications"
|
|
fullName: "com.azure.resourcemanager.support.models.Communications"
|
|
name: "Communications"
|
|
nameWithType: "Communications"
|
|
summary: "Resource collection API of Communications."
|
|
syntax: "public interface **Communications**"
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.support.models.Communications.checkNameAvailability(java.lang.String,com.azure.resourcemanager.support.models.CheckNameAvailabilityInput)"
|
|
fullName: "com.azure.resourcemanager.support.models.Communications.checkNameAvailability(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput)"
|
|
name: "checkNameAvailability(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput)"
|
|
nameWithType: "Communications.checkNameAvailability(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput)"
|
|
summary: "Check the availability of a resource name."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Support ticket name."
|
|
name: "supportTicketName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Input to check."
|
|
name: "checkNameAvailabilityInput"
|
|
type: "<xref href=\"com.azure.resourcemanager.support.models.CheckNameAvailabilityInput?alt=com.azure.resourcemanager.support.models.CheckNameAvailabilityInput&text=CheckNameAvailabilityInput\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract CheckNameAvailabilityOutput checkNameAvailability(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput)"
|
|
desc: "Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket."
|
|
returns:
|
|
description: "output of check name availability API."
|
|
type: "<xref href=\"com.azure.resourcemanager.support.models.CheckNameAvailabilityOutput?alt=com.azure.resourcemanager.support.models.CheckNameAvailabilityOutput&text=CheckNameAvailabilityOutput\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.support.models.Communications.checkNameAvailabilityWithResponse(java.lang.String,com.azure.resourcemanager.support.models.CheckNameAvailabilityInput,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.support.models.Communications.checkNameAvailabilityWithResponse(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput, Context context)"
|
|
name: "checkNameAvailabilityWithResponse(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput, Context context)"
|
|
nameWithType: "Communications.checkNameAvailabilityWithResponse(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput, Context context)"
|
|
summary: "Check the availability of a resource name."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Support ticket name."
|
|
name: "supportTicketName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Input to check."
|
|
name: "checkNameAvailabilityInput"
|
|
type: "<xref href=\"com.azure.resourcemanager.support.models.CheckNameAvailabilityInput?alt=com.azure.resourcemanager.support.models.CheckNameAvailabilityInput&text=CheckNameAvailabilityInput\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The context to associate with this operation."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Response<CheckNameAvailabilityOutput> checkNameAvailabilityWithResponse(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput, Context context)"
|
|
desc: "Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket."
|
|
returns:
|
|
description: "output of check name availability API along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.support.models.CheckNameAvailabilityOutput?alt=com.azure.resourcemanager.support.models.CheckNameAvailabilityOutput&text=CheckNameAvailabilityOutput\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.support.models.Communications.define(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.support.models.Communications.define(String name)"
|
|
name: "define(String name)"
|
|
nameWithType: "Communications.define(String name)"
|
|
summary: "Begins definition for a new Communication<wbr>Details resource."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "resource name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract CommunicationDetails.DefinitionStages.Blank define(String name)"
|
|
desc: "Begins definition for a new CommunicationDetails resource."
|
|
returns:
|
|
description: "the first stage of the new CommunicationDetails definition."
|
|
type: "<xref href=\"com.azure.resourcemanager.support.models.CommunicationDetails.DefinitionStages.Blank?alt=com.azure.resourcemanager.support.models.CommunicationDetails.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.support.models.Communications.get(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.support.models.Communications.get(String supportTicketName, String communicationName)"
|
|
name: "get(String supportTicketName, String communicationName)"
|
|
nameWithType: "Communications.get(String supportTicketName, String communicationName)"
|
|
summary: "Returns communication details for a support ticket."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Support ticket name."
|
|
name: "supportTicketName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Communication name."
|
|
name: "communicationName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract CommunicationDetails get(String supportTicketName, String communicationName)"
|
|
desc: "Returns communication details for a support ticket."
|
|
returns:
|
|
description: "object that represents a Communication resource."
|
|
type: "<xref href=\"com.azure.resourcemanager.support.models.CommunicationDetails?alt=com.azure.resourcemanager.support.models.CommunicationDetails&text=CommunicationDetails\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.support.models.Communications.getById(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.support.models.Communications.getById(String id)"
|
|
name: "getById(String id)"
|
|
nameWithType: "Communications.getById(String id)"
|
|
summary: "Returns communication details for a support ticket."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the resource ID."
|
|
name: "id"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract CommunicationDetails getById(String id)"
|
|
desc: "Returns communication details for a support ticket."
|
|
returns:
|
|
description: "object that represents a Communication resource along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.resourcemanager.support.models.CommunicationDetails?alt=com.azure.resourcemanager.support.models.CommunicationDetails&text=CommunicationDetails\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.support.models.Communications.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.support.models.Communications.getByIdWithResponse(String id, Context context)"
|
|
name: "getByIdWithResponse(String id, Context context)"
|
|
nameWithType: "Communications.getByIdWithResponse(String id, Context context)"
|
|
summary: "Returns communication details for a support ticket."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the resource ID."
|
|
name: "id"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The context to associate with this operation."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Response<CommunicationDetails> getByIdWithResponse(String id, Context context)"
|
|
desc: "Returns communication details for a support ticket."
|
|
returns:
|
|
description: "object that represents a Communication resource along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.support.models.CommunicationDetails?alt=com.azure.resourcemanager.support.models.CommunicationDetails&text=CommunicationDetails\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.support.models.Communications.getWithResponse(java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.support.models.Communications.getWithResponse(String supportTicketName, String communicationName, Context context)"
|
|
name: "getWithResponse(String supportTicketName, String communicationName, Context context)"
|
|
nameWithType: "Communications.getWithResponse(String supportTicketName, String communicationName, Context context)"
|
|
summary: "Returns communication details for a support ticket."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Support ticket name."
|
|
name: "supportTicketName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Communication name."
|
|
name: "communicationName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The context to associate with this operation."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Response<CommunicationDetails> getWithResponse(String supportTicketName, String communicationName, Context context)"
|
|
desc: "Returns communication details for a support ticket."
|
|
returns:
|
|
description: "object that represents a Communication resource along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.support.models.CommunicationDetails?alt=com.azure.resourcemanager.support.models.CommunicationDetails&text=CommunicationDetails\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.support.models.Communications.list(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.support.models.Communications.list(String supportTicketName)"
|
|
name: "list(String supportTicketName)"
|
|
nameWithType: "Communications.list(String supportTicketName)"
|
|
summary: "Lists all communications (attachments not included) for a support ticket."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Support ticket name."
|
|
name: "supportTicketName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract PagedIterable<CommunicationDetails> list(String supportTicketName)"
|
|
desc: "Lists all communications (attachments not included) for a support ticket. <br/></br> You can also filter support ticket communications by \\_CreatedDate\\_ or \\_CommunicationType\\_ using the $filter parameter. The only type of communication supported today is \\_Web\\_. Output will be a paged result with \\_nextLink\\_, using which you can retrieve the next set of Communication results. <br/><br/>Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error."
|
|
returns:
|
|
description: "collection of Communication resources as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.support.models.CommunicationDetails?alt=com.azure.resourcemanager.support.models.CommunicationDetails&text=CommunicationDetails\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.support.models.Communications.list(java.lang.String,java.lang.Integer,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.support.models.Communications.list(String supportTicketName, Integer top, String filter, Context context)"
|
|
name: "list(String supportTicketName, Integer top, String filter, Context context)"
|
|
nameWithType: "Communications.list(String supportTicketName, Integer top, String filter, Context context)"
|
|
summary: "Lists all communications (attachments not included) for a support ticket."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Support ticket name."
|
|
name: "supportTicketName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The number of values to return in the collection. Default is 10 and max is 10."
|
|
name: "top"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The filter to apply on the operation. You can filter by communicationType and createdDate\n properties. CommunicationType supports Equals ('eq') operator and createdDate supports Greater Than ('gt') and\n Greater Than or Equals ('ge') operators. You may combine the CommunicationType and CreatedDate filters by Logical\n And ('and') operator."
|
|
name: "filter"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The context to associate with this operation."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract PagedIterable<CommunicationDetails> list(String supportTicketName, Integer top, String filter, Context context)"
|
|
desc: "Lists all communications (attachments not included) for a support ticket. <br/></br> You can also filter support ticket communications by \\_CreatedDate\\_ or \\_CommunicationType\\_ using the $filter parameter. The only type of communication supported today is \\_Web\\_. Output will be a paged result with \\_nextLink\\_, using which you can retrieve the next set of Communication results. <br/><br/>Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error."
|
|
returns:
|
|
description: "collection of Communication resources as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.support.models.CommunicationDetails?alt=com.azure.resourcemanager.support.models.CommunicationDetails&text=CommunicationDetails\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "interface"
|
|
desc: "Resource collection API of Communications."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.support.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-support:1.0.0
|